GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1GlobalSettingStation.tex

171 lines
9.6 KiB
TeX
Raw Permalink Normal View History

2022-05-08 19:59:26 +00:00
\hypertarget{classGpgFrontend_1_1GlobalSettingStation}{}\doxysection{Gpg\+Frontend\+::Global\+Setting\+Station Class Reference}
\label{classGpgFrontend_1_1GlobalSettingStation}\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
Singleton class for managing global settings in the application.
{\ttfamily \#include $<$Global\+Setting\+Station.\+h$>$}
2022-05-08 19:59:26 +00:00
Inheritance diagram for Gpg\+Frontend\+::Global\+Setting\+Station\+:
2022-05-08 22:01:23 +00:00
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=550pt]{classGpgFrontend_1_1GlobalSettingStation__inherit__graph}
\end{center}
\end{figure}
2022-05-08 19:59:26 +00:00
Collaboration diagram for Gpg\+Frontend\+::Global\+Setting\+Station\+:
2022-05-08 22:01:23 +00:00
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=550pt]{classGpgFrontend_1_1GlobalSettingStation__coll__graph}
2022-05-08 22:01:23 +00:00
\end{center}
\end{figure}
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item
class \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_1_1Impl}{Impl}}
\end{DoxyCompactItemize}
2022-05-08 19:59:26 +00:00
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_abdc6dda369d4214e43ffa2930f7386b0}\label{classGpgFrontend_1_1GlobalSettingStation_abdc6dda369d4214e43ffa2930f7386b0}}
\mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_abdc6dda369d4214e43ffa2930f7386b0}{Global\+Setting\+Station}} (int channel=\mbox{\hyperlink{classGpgFrontend_1_1SingletonFunctionObject_ad983153cbe3a0c32c123c506e04f31fc}{Singleton\+Function\+Object\+::\+Get\+Default\+Channel}}()) noexcept
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em Construct a new Global Setting Station object. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_af700161900e623a0ea14261d51616451}\label{classGpgFrontend_1_1GlobalSettingStation_af700161900e623a0ea14261d51616451}}
2022-05-08 22:01:23 +00:00
\mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_af700161900e623a0ea14261d51616451}{$\sim$\+Global\+Setting\+Station}} () noexcept override
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em Destroy the Global Setting Station object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_ac767d0c3240d366cbb4f5f7e7e6c5562}{Get\+Settings}} () const -\/$>$ QSettings
\begin{DoxyCompactList}\small\item\em Get the Settings object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a0493f07e63b300e272826561bbc6d9f7}{Get\+App\+Dir}} () const -\/$>$ QString
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em Get the App Dir object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a7da8fc60ba403d6addd8f671089faeaa}{Get\+App\+Data\+Path}} () const -\/$>$ QString
\begin{DoxyCompactList}\small\item\em Gets the application data directory. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a7a7eb68d192184bb2f447abbb4440fec}{Get\+Log\+Dir}} () const -\/$>$ QString
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em Get the Log Dir object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a6521cacfd63f42558399077f9301e500}{Get\+Log\+Files\+Size}} () const -\/$>$ QString
\begin{DoxyCompactList}\small\item\em Get the Log Files Size object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a67d731d4a2c0f3033c9f6b6f52094e25}{Get\+Data\+Objects\+Files\+Size}} () const -\/$>$ QString
\begin{DoxyCompactList}\small\item\em Get the Data Objects Files Size object. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a43c472c40896308e7bbc14796b5740af}\label{classGpgFrontend_1_1GlobalSettingStation_a43c472c40896308e7bbc14796b5740af}}
void \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a43c472c40896308e7bbc14796b5740af}{Clear\+All\+Log\+Files}} () const
\begin{DoxyCompactList}\small\item\em clear all log files \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a393186ae479062b007a41485f608636f}\label{classGpgFrontend_1_1GlobalSettingStation_a393186ae479062b007a41485f608636f}}
void \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_a393186ae479062b007a41485f608636f}{Clear\+All\+Data\+Objects}} () const
\begin{DoxyCompactList}\small\item\em clear all data objects \end{DoxyCompactList}\end{DoxyCompactItemize}
2022-05-08 19:59:26 +00:00
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a001bfe0040dcbf932fb02fddb1617019}\label{classGpgFrontend_1_1GlobalSettingStation_a001bfe0040dcbf932fb02fddb1617019}}
Secure\+Unique\+Ptr$<$ \mbox{\hyperlink{classGpgFrontend_1_1GlobalSettingStation_1_1Impl}{Impl}} $>$ {\bfseries p\+\_\+}
\end{DoxyCompactItemize}
2022-05-08 19:59:26 +00:00
\doxysubsection*{Additional Inherited Members}
\doxysubsection{Detailed Description}
Singleton class for managing global settings in the application.
This class handles reading and writing of global settings, as well as managing application directories and resource paths.
2022-05-08 19:59:26 +00:00
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a7da8fc60ba403d6addd8f671089faeaa}\label{classGpgFrontend_1_1GlobalSettingStation_a7da8fc60ba403d6addd8f671089faeaa}}
\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}!GetAppDataPath@{GetAppDataPath}}
\index{GetAppDataPath@{GetAppDataPath}!GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
\doxysubsubsection{\texorpdfstring{GetAppDataPath()}{GetAppDataPath()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Global\+Setting\+Station\+::\+Get\+App\+Data\+Path (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ QString}
2022-05-08 19:59:26 +00:00
Gets the application data directory.
2022-05-08 19:59:26 +00:00
\begin{DoxyReturn}{Returns}
Path to the application data directory.
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a0493f07e63b300e272826561bbc6d9f7}\label{classGpgFrontend_1_1GlobalSettingStation_a0493f07e63b300e272826561bbc6d9f7}}
\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}!GetAppDir@{GetAppDir}}
\index{GetAppDir@{GetAppDir}!GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
\doxysubsubsection{\texorpdfstring{GetAppDir()}{GetAppDir()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Global\+Setting\+Station\+::\+Get\+App\+Dir (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ QString}
2022-05-08 19:59:26 +00:00
Get the App Dir object.
2022-05-08 19:59:26 +00:00
\begin{DoxyReturn}{Returns}
QString
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a67d731d4a2c0f3033c9f6b6f52094e25}\label{classGpgFrontend_1_1GlobalSettingStation_a67d731d4a2c0f3033c9f6b6f52094e25}}
\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}!GetDataObjectsFilesSize@{GetDataObjectsFilesSize}}
\index{GetDataObjectsFilesSize@{GetDataObjectsFilesSize}!GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
\doxysubsubsection{\texorpdfstring{GetDataObjectsFilesSize()}{GetDataObjectsFilesSize()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Global\+Setting\+Station\+::\+Get\+Data\+Objects\+Files\+Size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ QString}
2022-05-08 19:59:26 +00:00
Get the Data Objects Files Size object.
2022-05-08 19:59:26 +00:00
\begin{DoxyReturn}{Returns}
QString
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a7a7eb68d192184bb2f447abbb4440fec}\label{classGpgFrontend_1_1GlobalSettingStation_a7a7eb68d192184bb2f447abbb4440fec}}
2022-05-08 19:59:26 +00:00
\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}!GetLogDir@{GetLogDir}}
\index{GetLogDir@{GetLogDir}!GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
\doxysubsubsection{\texorpdfstring{GetLogDir()}{GetLogDir()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Global\+Setting\+Station\+::\+Get\+Log\+Dir (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ QString}
2022-05-08 19:59:26 +00:00
Get the Log Dir object.
\begin{DoxyReturn}{Returns}
QString
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_a6521cacfd63f42558399077f9301e500}\label{classGpgFrontend_1_1GlobalSettingStation_a6521cacfd63f42558399077f9301e500}}
\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}!GetLogFilesSize@{GetLogFilesSize}}
\index{GetLogFilesSize@{GetLogFilesSize}!GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
\doxysubsubsection{\texorpdfstring{GetLogFilesSize()}{GetLogFilesSize()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Global\+Setting\+Station\+::\+Get\+Log\+Files\+Size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ QString}
2022-05-08 19:59:26 +00:00
Get the Log Files Size object.
\begin{DoxyReturn}{Returns}
QString
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1GlobalSettingStation_ac767d0c3240d366cbb4f5f7e7e6c5562}\label{classGpgFrontend_1_1GlobalSettingStation_ac767d0c3240d366cbb4f5f7e7e6c5562}}
\index{GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}!GetSettings@{GetSettings}}
\index{GetSettings@{GetSettings}!GpgFrontend::GlobalSettingStation@{GpgFrontend::GlobalSettingStation}}
\doxysubsubsection{\texorpdfstring{GetSettings()}{GetSettings()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Global\+Setting\+Station\+::\+Get\+Settings (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const -\/$>$ QSettings}
Get the Settings object.
2022-05-08 19:59:26 +00:00
\begin{DoxyReturn}{Returns}
QSettings
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
References Get\+Settings().
2022-05-08 19:59:26 +00:00
Referenced by Get\+Settings().
2022-05-08 19:59:26 +00:00
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/core/function/Global\+Setting\+Station.\+h\item
src/core/function/Global\+Setting\+Station.\+cpp\end{DoxyCompactItemize}