X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3972fb4919148d1ed67f897ea5beb67eedd662f6..80d2803f703d1b238f42725504f08266ef02defe:/docs/latex/wx/config.tex diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 536d025736..51e85c0c61 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -1,9 +1,8 @@ \section{\class{wxConfigBase}}\label{wxconfigbase} wxConfigBase class defines the basic interface of all config classes. It can -not be used by itself (it's an abstract base class) and you'll always use one -of its derivations: wxIniConfig, wxFileConfig, wxRegConfig or -any other. +not be used by itself (it is an abstract base class) and you will always use one +of its derivations: wxIniConfig, wxFileConfig, wxRegConfig or any other. However, usually you don't even need to know the precise nature of the class you're working with but you would just use the wxConfigBase methods. This @@ -15,13 +14,24 @@ which is mapped onto the native wxConfigBase implementation on the given platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and wxFileConfig otherwise. -%See \helpref{config overview}{configoverview} for the descriptions of all -%features of this class. +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 +\wxheading{Include files} + + (to let wxWindows choose a wxConfig class for your platform)\\ + (base config class)\\ + (wxFileconfig class)\\ + (wxRegConfig class)\\ + (wxIniConfig class) + \wxheading{Example} Here is how you would typically use this class: @@ -68,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 @@ -86,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}\\ @@ -98,12 +113,12 @@ disable this behaviour {\it DontCreateOnDemand()} is provided. \membersection{Path management} -%As explained in \helpref{config overview}{configoverview}, -The config classes support a file system-like hierarchy of keys (files) and groups (directories). +As explained in \helpref{config overview}{wxconfigoverview}, the config classes +support a file system-like hierarchy of keys (files) and groups (directories). As in the file system case, to specify a key in the config class you must use a path to it. Config classes also support the notion of the current group, which makes it possible to use the relative paths. To clarify all this, here -is an example (it's only for the sake of demonstration, it doesn't do anything +is an example (it is only for the sake of demonstration, it doesn't do anything sensible!): \begin{verbatim} @@ -117,18 +132,18 @@ sensible!): // create an entry in subgroup conf->Write("SubgroupEntry", 3); - + // '..' is understood conf->Write("../GroupEntry", 2); conf->SetPath(".."); wxASSERT( conf->Read("Subgroup/SubgroupEntry", 0l) == 3 ); - // use absolute path: it's allowed, too + // use absolute path: it is allowed, too wxASSERT( conf->Read("/RootEntry", 0l) == 1 ); \end{verbatim} -{\it Warning}: it's probably a good idea to always restore the path to its +{\it Warning}: it is probably a good idea to always restore the path to its old value on function exit: \begin{verbatim} @@ -151,7 +166,7 @@ doesn't save and restore the path): void bar(wxConfigBase *config) { config->Write("Test", 17); - + foo(config); // we're reading "/Foo/Data/Test" here! -1 will probably be returned... @@ -160,7 +175,7 @@ doesn't save and restore the path): \end{verbatim} Finally, the path separator in wxConfigBase and derived classes is always '/', -regardless of the platform (i.e. it's {\bf not} '$\backslash\backslash$' under Windows). +regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under Windows). \helpref{SetPath}{wxconfigbasesetpath}\\ \helpref{GetPath}{wxconfigbasegetpath} @@ -171,9 +186,9 @@ The functions in this section allow to enumerate all entries and groups in the config file. All functions here return FALSE when there are no more items. You must pass the same index to GetNext and GetFirst (don't modify it). -Please note that it's {\bf not} the index of the current item (you will have +Please note that it is {\bf not} the index of the current item (you will have some great surprizes with wxRegConfig if you assume this) and you shouldn't -even look at it: it's just a "cookie" which stores the state of the +even look at it: it is just a "cookie" which stores the state of the enumeration. It can't be stored inside the class because it would prevent you from running several enumerations simultaneously, that's why you must pass it explicitly. @@ -223,14 +238,14 @@ actually enumerating them, but you will probably never need them. \helpref{HasGroup}{wxconfigbasehasgroup}\\ \helpref{HasEntry}{wxconfigbasehasentry}\\ -\helpref{Exists}{wxconfigbaseexists} +\helpref{Exists}{wxconfigbaseexists}\\ +\helpref{GetEntryType}{wxconfigbasegetentrytype} -\membersection{Miscellaneous accessors} +\membersection{Miscellaneous functions} -\helpref{SetAppName}{wxconfigbasesetappname}\\ \helpref{GetAppName}{wxconfigbasegetappname}\\ -\helpref{SetVendorName}{wxconfigbasesetvendorname}\\ -\helpref{GetVendorName}{wxconfigbasegetvendorname} +\helpref{GetVendorName}{wxconfigbasegetvendorname}\\ +\helpref{SetUmask}{wxfileconfigsetumask} \membersection{Key access} @@ -258,6 +273,17 @@ arbitrary path (either relative or absolute), not just the key name. \helpref{Write}{wxconfigbasewrite}\\ \helpref{Flush}{wxconfigbaseflush} +\membersection{Rename entries/groups} + +The functions in this section allow to rename entries or subgroups of the +current group. They will return FALSE on error. typically because either the +entry/group with the original name doesn't exist, because the entry/group with +the new name already exists or because the function is not supported in this +wxConfig implementation. + +\helpref{RenameEntry}{wxconfigbaserenameentry}\\ +\helpref{RenameGroup}{wxconfigbaserenamegroup} + \membersection{Delete entries/groups} The functions in this section delete entries and/or groups of entries from the @@ -296,7 +322,7 @@ would be to prefix the offending symbols with a backslash. The following functions control this option: \helpref{IsExpandingEnvVars}{wxconfigbaseisexpandingenvvars}\\ -\helpref{SetExpandingEnvVars}{wxconfigbasesetexpandingenvvars}\\ +\helpref{SetExpandEnvVars}{wxconfigbasesetexpandenvvars}\\ \helpref{SetRecordDefaults}{wxconfigbasesetrecorddefaults}\\ \helpref{IsRecordingDefaults}{wxconfigbaseisrecordingdefaults} @@ -315,35 +341,40 @@ The following functions control this option: \param{const wxString\& }{globalFilename = wxEmptyString}, \param{long}{ style = 0}} -This is the default and only constructor of the wxConfigBase class, and derived classes. +This is the default and only constructor of the wxConfigBase class, and +derived classes. \wxheading{Parameters} -\docparam{appName}{The application name. If this is empty, the class will normally -use \helpref{wxApp::GetAppName}{wxappgetappname} to set it. The application name -is used in the registry key on Windows, and can be used to deduce the local filename -parameter if that is missing.} +\docparam{appName}{The application name. If this is empty, the class will +normally use \helpref{wxApp::GetAppName}{wxappgetappname} to set it. The +application name is used in the registry key on Windows, and can be used to +deduce the local filename parameter if that is missing.} \docparam{vendorName}{The vendor name. If this is empty, it is assumed that no vendor name is wanted, if this is optional for the current config class. The vendor name is appended to the application name for wxRegConfig.} -\docparam{localFilename}{Some config classes require a local filename. If this is not -present, but required, the application name will be used instead.} +\docparam{localFilename}{Some config classes require a local filename. If this +is not present, but required, the application name will be used instead.} -\docparam{globalFilename}{Some config classes require a global filename. If this is not -present, but required, the application name will be used instead.} +\docparam{globalFilename}{Some config classes require a global filename. If +this is not present, but required, the application name will be used instead.} -\docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and wxCONFIG\_USE\_GLOBAL\_FILE. -The style interpretation depends on the config class and is ignored by some. -For wxFileConfig, these styles determine whether a local or global config file is created or used. -If the flag is present but the parameter is empty, the parameter will be set to a default. -If the parameter is present but the style flag not, the relevant flag will be added to the style.} +\docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and +wxCONFIG\_USE\_GLOBAL\_FILE. The style interpretation depends on the config +class and is ignored by some. For wxFileConfig, these styles determine whether +a local or global config file is created or used. If the flag is present but +the parameter is empty, the parameter will be set to a default. If the +parameter is present but the style flag not, the relevant flag will be added +to the style. For wxFileConfig you can also add wxCONFIG\_USE\_RELATIVE\_PATH +by logicaly or'ing it to either of the \_FILE options to tell wxFileConfig to +use relative instead of absolute paths. } \wxheading{Remarks} -By default, environment variable expansion is on and recording -defaults is off. +By default, environment variable expansion is on and recording defaults is +off. \membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor} @@ -356,9 +387,9 @@ Empty but ensures that dtor of all derived classes is virtual. \func{static wxConfigBase *}{Create}{\void} Create a new config object: this function will create the "best" -implementation of wxConfig available for the current platform, see -comments near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns -the created object and also sets it as the current one. +implementation of wxConfig available for the current platform, see comments +near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns the +created object and also sets it as the current one. \membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand} @@ -379,8 +410,8 @@ for use by desinstallation routine. \func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = TRUE}} -Deletes the specified entry and the group it belongs to if -it was the last key in it and the second parameter is true. +Deletes the specified entry and the group it belongs to if it was the last key +in it and the second parameter is true. \membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup} @@ -403,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} @@ -414,30 +446,69 @@ Get the current config object. If there is no current object, creates one Returns the application name. +\membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype} + +\constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}} + +Returns the type of the given entry or {\it Unknown} if the entry doesn't +exist. This function should be used to decide which version of Read() should +be used because some of wxConfig implementations will complain about type +mismatch otherwise: e.g., an attempt to read a string value from an integer +key with wxRegConfig will fail. + +The result is an element of enum EntryType: + +\begin{verbatim} + enum EntryType + { + Unknown, + String, + Boolean, + Integer, + Float + }; +\end{verbatim} + \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup} \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the first group. +\pythonnote{The wxPython version of this method returns a 3-tuple +consisting of the continue flag, the value string, and the index for +the next call.} + \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry} \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the first entry. +\pythonnote{The wxPython version of this method returns a 3-tuple +consisting of the continue flag, the value string, and the index for +the next call.} + \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup} \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the next group. +\pythonnote{The wxPython version of this method returns a 3-tuple +consisting of the continue flag, the value string, and the index for +the next call.} + \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry} \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the next entry. +\pythonnote{The wxPython version of this method returns a 3-tuple +consisting of the continue flag, the value string, and the index for +the next call.} + \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries} \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}} @@ -446,8 +517,8 @@ Gets the next entry. \constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = FALSE}} -Get number of entries/subgroups in the current group, with or without -its subgroups. +Get number of entries/subgroups in the current group, with or without its +subgroups. \membersection{wxConfigBase::GetPath}\label{wxconfigbasegetpath} @@ -481,7 +552,7 @@ Returns TRUE if we are expanding environment variables in key values. \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults} -\func{bool}{IsRecordingDefaults}{\void} const +\constfunc{bool}{IsRecordingDefaults}{\void} Returns TRUE if we are writing defaults back to the config file. @@ -489,69 +560,98 @@ Returns TRUE if we are writing defaults back to the config file. \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}} -Read a string from the key, returning TRUE if the value was read. If the key was not -found, {\it str} is not changed. +Read a string from the key, returning TRUE if the value was read. If the key +was not found, {\it str} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}} -Read a string from the key. The default value is returned if the key was not found. +Read a string from the key. The default value is returned if the key was not +found. Returns TRUE if value was really read, FALSE if the default was used. -\constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const wxString\& }{defaultVal}} +\constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const +wxString\& }{defaultVal}} Another version of {\it Read()}, returning the string value directly. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}} -Reads a long value, returning TRUE if the value was -found. If the value was not found, {\it l} is not changed. +Reads a long value, returning TRUE if the value was found. If the value was +not found, {\it l} is not changed. -\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}, \param{long}{ defaultVal}} +\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}, +\param{long}{ defaultVal}} -Reads a long value, returning TRUE if the value was -found. If the value was not found, {\it defaultVal} is used instead. +Reads a long value, returning TRUE if the value was found. If the value was +not found, {\it defaultVal} is used instead. \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}} -Reads a long value from the key and returns it. {\it defaultVal} is returned if the key is not -found. +Reads a long value from the key and returns it. {\it defaultVal} is returned +if the key is not found. NB: writing -{\small -\begin{verbatim} - conf->Read("key", 0); -\end{verbatim} -} +{\small \begin{verbatim} conf->Read("key", 0); \end{verbatim} } -won't work because the call is ambiguous: compiler can not choose between two {\it Read} functions. Instead, write: +won't work because the call is ambiguous: compiler can not choose between two +{\it Read} functions. Instead, write: -{\small -\begin{verbatim} - conf->Read("key", 0l); -\end{verbatim} -} +{\small \begin{verbatim} conf->Read("key", 0l); \end{verbatim} } \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}} -Reads a double value, returning TRUE if the value was -found. If the value was not found, {\it d} is not changed. +Reads a double value, returning TRUE if the value was found. If the value was +not found, {\it d} is not changed. -\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}, \param{double}{ defaultVal}} +\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}, + \param{double}{ defaultVal}} -Reads a double value, returning TRUE if the value was -found. If the value was not found, {\it defaultVal} is used instead. +Reads a double value, returning TRUE if the value was found. If the value was +not found, {\it defaultVal} is used instead. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}} -Reads a bool value, returning TRUE if the value was -found. If the value was not found, {\it b} is not changed. +Reads a bool value, returning TRUE if the value was found. If the value was +not found, {\it b} is not changed. + +\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d}, +\param{bool}{ defaultVal}} + +Reads a bool value, returning TRUE if the value was found. If the value was +not found, {\it defaultVal} is used instead. + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf Read(key, default="")}}{Returns a string.} +\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an int.} +\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number.} +\end{twocollist}} +} + +\membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry} + +\func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}} + +Renames an entry in the current group. The entries names (both the old and +the new one) shouldn't contain backslashes, i.e. only simple names and not +arbitrary paths are accepted by this function. + +Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already +exists. + +\membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup} + +\func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}} -\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d}, \param{bool}{ defaultVal}} +Renames a subgroup of the current group. The subgroup names (both the old and +the new one) shouldn't contain backslashes, i.e. only simple names and not +arbitrary paths are accepted by this function. -Reads a bool value, returning TRUE if the value was -found. If the value was not found, {\it defaultVal} is used instead. +Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already +exists. \membersection{wxConfigBase::Set}\label{wxconfigbaseset} @@ -560,13 +660,7 @@ found. If the value was not found, {\it defaultVal} is used instead. Sets the config object as the current one, returns the pointer to the previous current object (both the parameter and returned value may be NULL) -\membersection{wxConfigBase::SetAppName}\label{wxconfigbasesetappname} - -\func{void }{SetAppName}{\param{const wxString\&}{ appName}} - -Sets the application name. - -\membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars} +\membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars} \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}} @@ -576,9 +670,9 @@ Determine whether we wish to expand environment variables in key values. \func{void}{SetPath}{\param{const wxString\& }{strPath}} -Set current path: if the first character is '/', it's the absolute path, -otherwise it's a relative path. '..' is supported. If the strPath -doesn't exist it is created. +Set current path: if the first character is '/', it is the absolute path, +otherwise it is a relative path. '..' is supported. If the strPath doesn't +exist it is created. \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults} @@ -586,19 +680,27 @@ doesn't exist it is created. Sets whether defaults are written back to the config file. -If on (default is off) all default values are written back to the config file. This allows -the user to see what config options may be changed and is probably useful only -for wxFileConfig. +If on (default is off) all default values are written back to the config file. +This allows the user to see what config options may be changed and is probably +useful only for wxFileConfig. -\membersection{wxConfigBase::SetVendorName}\label{wxconfigbasesetvendorname} +\membersection{wxConfigBase::SetUmask}\label{wxfileconfigsetumask} -\func{void}{SetVendorName}{\param{const wxString\&}{ vendorName}} +\func{void}{SetUmask}{\param{int }{mode}} -Sets the vendor name. +{\bf NB:} this function is not in the base wxConfigBase class but is only +implemented in wxFileConfig. Moreover, this function is Unix-specific and +doesn't do anything on other platforms. + +SetUmask() allows to set the mode to be used for the config file creation. +For example, to create a config file which is not readable by other users +(useful if it stores some sensitive information, such as passwords), you +should do {\tt SetUmask(0077)}. \membersection{wxConfigBase::Write}\label{wxconfigbasewrite} -\func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{ value}} +\func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{ +value}} \func{bool}{Write}{\param{const wxString\& }{ key}, \param{long}{ value}} @@ -606,7 +708,15 @@ Sets the vendor name. \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}} -These functions write the specified value to the config file and -return TRUE on success. +These functions write the specified value to the config file and return TRUE +on success. +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf Write(key, value)}}{Writes a string.} +\twocolitem{{\bf WriteInt(key, value)}}{Writes an int.} +\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number.} +\end{twocollist}} +}