From eee786e9cb8e3dde04c7e51d30bed4db74db7bfc Mon Sep 17 00:00:00 2001 From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Mon, 17 Jan 2000 17:18:27 +0000 Subject: [PATCH] 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 --- docs/latex/wx/config.tex | 15 ++++++++++++--- include/wx/confbase.h | 3 ++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 5029b8b12d..2e231e1e8c 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -17,6 +17,9 @@ wxFileConfig otherwise. See \helpref{config overview}{wxconfigoverview} for the descriptions of all 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} No base class @@ -75,7 +78,7 @@ physical storage where a wxConfigBase-derived class stores its data. \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 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 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{Get}{wxconfigbaseget}\\ \helpref{Create}{wxconfigbasecreate}\\ @@ -426,9 +434,10 @@ destructor) \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. \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname} diff --git a/include/wx/confbase.h b/include/wx/confbase.h index abb5f96dd0..fb9f8f7127 100644 --- a/include/wx/confbase.h +++ b/include/wx/confbase.h @@ -90,7 +90,8 @@ public: static wxConfigBase *Set(wxConfigBase *pConfig); // get the config object, creates it on demand unless DontCreateOnDemand // 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" // implementation of wxConfig available for the current platform, see // comments near definition wxUSE_CONFIG_NATIVE for details. It returns -- 2.45.2