changed wxConfigBase::Get signature to wxConfigBase::Get(bool CreateOnDemand = TRUE)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5474 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2000-01-17 17:18:27 +00:00
parent 76a4f50db5
commit eee786e9cb
2 changed files with 14 additions and 4 deletions

View File

@@ -17,6 +17,9 @@ wxFileConfig otherwise.
See \helpref{config overview}{wxconfigoverview} for the descriptions of all See \helpref{config overview}{wxconfigoverview} for the descriptions of all
features of this class. features of this class.
It is highly recommended to use static functions {\it Get()} and/or {\it Set()},
so please have a \helpref{look at them.}{wxconfigstaticfunctions}
\wxheading{Derived from} \wxheading{Derived from}
No base class No base class
@@ -75,7 +78,7 @@ physical storage where a wxConfigBase-derived class stores its data.
\latexignore{\rtfignore{\wxheading{Function groups}}} \latexignore{\rtfignore{\wxheading{Function groups}}}
\membersection{Static functions} \membersection{Static functions}\label{wxconfigstaticfunctions}
These functions deal with the "default" config object. Although its usage is These functions deal with the "default" config object. Although its usage is
not at all mandatory it may be convenient to use a global config object not at all mandatory it may be convenient to use a global config object
@@ -93,6 +96,11 @@ you may forget about calling {\it Set()}. When {\it Get()} is called and there
is no current object, it will create one using {\it Create()} function. To is no current object, it will create one using {\it Create()} function. To
disable this behaviour {\it DontCreateOnDemand()} is provided. disable this behaviour {\it DontCreateOnDemand()} is provided.
{\bf Note:} You should use either {\it Set()} or {\it Get()} because wxWindows
library itself would take advantage of it and could save various information
in it. For example \helpref{wxFontMapper}{wxfontmapper} or Unix version
of \helpref{wxFileDialog}{wxfiledialog} have ability to use wxConfig class.
\helpref{Set}{wxconfigbaseset}\\ \helpref{Set}{wxconfigbaseset}\\
\helpref{Get}{wxconfigbaseget}\\ \helpref{Get}{wxconfigbaseget}\\
\helpref{Create}{wxconfigbasecreate}\\ \helpref{Create}{wxconfigbasecreate}\\
@@ -426,9 +434,10 @@ destructor)
\membersection{wxConfigBase::Get}\label{wxconfigbaseget} \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
\func{wxConfigBase *}{Get}{\void} \func{wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = TRUE}}
Get the current config object. If there is no current object, creates one Get the current config object. If there is no current object and
{\it CreateOnDemand} is TRUE, creates one
(using {\it Create}) unless DontCreateOnDemand was called previously. (using {\it Create}) unless DontCreateOnDemand was called previously.
\membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname} \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}

View File

@@ -90,7 +90,8 @@ public:
static wxConfigBase *Set(wxConfigBase *pConfig); static wxConfigBase *Set(wxConfigBase *pConfig);
// get the config object, creates it on demand unless DontCreateOnDemand // get the config object, creates it on demand unless DontCreateOnDemand
// was called // was called
static wxConfigBase *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; } static wxConfigBase *Get(bool createOnDemand = TRUE)
{ if ( createOnDemand && (!ms_pConfig) ) Create(); return ms_pConfig; }
// create a new config object: this function will create the "best" // create a new config object: this function will create the "best"
// implementation of wxConfig available for the current platform, see // implementation of wxConfig available for the current platform, see
// comments near definition wxUSE_CONFIG_NATIVE for details. It returns // comments near definition wxUSE_CONFIG_NATIVE for details. It returns