X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c91108763b1621be54af24e24b2fab590db87325..afbe906abdf9aa69a56571b8b20b095351dd8f34:/docs/latex/wx/config.tex?ds=sidebyside diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 5029b8b12d..f349c6f0fd 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -1,7 +1,7 @@ \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 +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 @@ -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 @@ -50,7 +53,7 @@ Here is how you would typically use this class: // another example: using default values and the full path instead of just // key name: if the key is not found , the value 17 is returned - long value = config->Read("/LastRun/CalculatedValues/MaxValue", -1); + long value = config->Read("/LastRun/CalculatedValues/MaxValue", 17); ... ... ... @@ -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 @@ -83,16 +86,21 @@ instead of creating and deleting the local config objects each time you need one (especially because creating a wxFileConfig object might be a time consuming operation). In this case, you may create this global config object in the very start of the program and {\it Set()} it as the default. Then, from -anywhere in your program, you may access it using the {\it Get()} function. Of -course, you should delete it on the program termination (otherwise, not only a -memory leak will result, but even more importantly the changes won't be -written back!). +anywhere in your program, you may access it using the {\it Get()} function. +Note that wxWindows will delete this config object for you during the program +shutdown (from \helpref{wxApp::OnExit}{wxapponexit} to be precise) but you can +also do it yourself earlier if needed. As it happens, you may even further simplify the procedure described above: 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}\\ @@ -110,7 +118,7 @@ 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} @@ -131,11 +139,11 @@ sensible!): 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} @@ -167,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} @@ -178,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. @@ -233,10 +241,11 @@ actually enumerating them, but you will probably never need them. \helpref{Exists}{wxconfigbaseexists}\\ \helpref{GetEntryType}{wxconfigbasegetentrytype} -\membersection{Miscellaneous accessors} +\membersection{Miscellaneous functions} \helpref{GetAppName}{wxconfigbasegetappname}\\ -\helpref{GetVendorName}{wxconfigbasegetvendorname} +\helpref{GetVendorName}{wxconfigbasegetvendorname}\\ +\helpref{SetUmask}{wxfileconfigsetumask} \membersection{Key access} @@ -248,7 +257,7 @@ Currently, only two types of data are supported: string and long (but it might change in the near future). To work with other types: for {\it int} or {\it bool} you can work with function taking/returning {\it long} and just use the casts. Better yet, just use {\it long} for all variables which you're going to -save in the config file: chances are that \verb$sizeof(bool) == sizeof(int) == sizeof(long)$ anyhow on your system. For {\it float}, {\it double} and, in +save in the config file: chances are that \tt{sizeof(bool) == sizeof(int) == sizeof(long)} anyhow on your system. For {\it float}, {\it double} and, in general, any other type you'd have to translate them to/from string representation and use string functions. @@ -299,9 +308,9 @@ config file: # the following syntax is valud only under Windows UserData = %windir%\\data.dat \end{verbatim} - -the call to \verb$config->Read("UserData")$ will return something like -\verb$"/home/zeitlin/data"$ if you're lucky enough to run a Linux system ;-) +% $ % help EMACS syntax highlighting... +the call to \tt{config->Read("UserData")} will return something like +\tt{"/home/zeitlin/data"} if you're lucky enough to run a Linux system ;-) Although this feature is very useful, it may be annoying if you read a value which containts '\$' or '\%' symbols (\% is used for environment variables @@ -313,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} @@ -399,8 +408,7 @@ for use by desinstallation routine. \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry} -\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ -bDeleteGroupIfEmpty = TRUE}} +\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. @@ -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} @@ -462,8 +471,7 @@ The result is an element of enum EntryType: \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup} -\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ -index}} +\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the first group. @@ -471,10 +479,12 @@ Gets the first group. consisting of the continue flag, the value string, and the index for the next call.} +\perlnote{In wxPerl this method takes no arguments and returns a 3-element +list {\tt ( continue, str, index )}.} + \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry} -\constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ -index}} +\constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the first entry. @@ -482,10 +492,12 @@ Gets the first entry. consisting of the continue flag, the value string, and the index for the next call.} +\perlnote{In wxPerl this method takes no arguments and returns a 3-element +list {\tt ( continue, str, index )}.} + \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup} -\constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ -index}} +\constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the next group. @@ -493,10 +505,12 @@ Gets the next group. consisting of the continue flag, the value string, and the index for the next call.} +\perlnote{In wxPerl this method only takes the {\tt index} parameter +and returns a 3-element list {\tt ( continue, str, index )}.} + \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry} -\constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ -index}} +\constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}} Gets the next entry. @@ -504,6 +518,9 @@ Gets the next entry. consisting of the continue flag, the value string, and the index for the next call.} +\perlnote{In wxPerl this method only takes the {\tt index} parameter +and returns a 3-element list {\tt ( continue, str, index )}.} + \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries} \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}} @@ -547,20 +564,18 @@ 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. \membersection{wxConfigBase::Read}\label{wxconfigbaseread} -\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ -str}} +\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. -\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ -str}, \param{const wxString\& }{defaultVal}} +\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. @@ -583,20 +598,27 @@ 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 defaultVal} is used instead. -\constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ -defaultVal}} +\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. 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: -{\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}} @@ -629,6 +651,15 @@ implements the following methods:\par \end{twocollist}} } +\perlnote{In place of a single overloaded method, wxPerl uses:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf Read(key, default="")}}{Returns a string} +\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an integer} +\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number} +\twocolitem{{\bf ReadBool(key, default=0)}}{Returns a boolean} +\end{twocollist} +}} + \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry} \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}} @@ -658,7 +689,7 @@ exists. 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::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars} +\membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars} \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}} @@ -668,19 +699,33 @@ 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 +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} \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}} -Sets whether defaults are written back to the config file. +Sets whether defaults are recorded to the config file whenever an attempt to +read read the value which is not present in it is done. + +If on (default is off) all default values for the settings used by the program +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::SetUmask}\label{wxfileconfigsetumask} + +\func{void}{SetUmask}{\param{int }{mode}} + +{\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. -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. +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} @@ -705,7 +750,11 @@ implements the following methods:\par \end{twocollist}} } - - - - +\perlnote{In place of a single overloaded method, wxPerl uses:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf Write(key, value)}}{Writes a string} +\twocolitem{{\bf WriteInt(key, value)}}{Writes an integer} +\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number} +\twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean} +\end{twocollist} +}}