Version: 3.3.0
config.h File Reference

Classes

class  wxConfigBase
 wxConfigBase defines the basic interface of all config classes. More...
 
class  wxConfigPathChanger
 A handy little class which changes the current path in a wxConfig object and restores it in dtor. More...
 

Enumerations

enum  {
  wxCONFIG_USE_LOCAL_FILE = 1 ,
  wxCONFIG_USE_GLOBAL_FILE = 2 ,
  wxCONFIG_USE_RELATIVE_PATH = 4 ,
  wxCONFIG_USE_NO_ESCAPE_CHARACTERS = 8 ,
  wxCONFIG_USE_SUBDIR = 16 ,
  wxCONFIG_USE_XDG = 32 ,
  wxCONFIG_USE_HOME = 64
}
 Flags for wxConfig constructor style parameter. More...
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Flags for wxConfig constructor style parameter.

Enumerator
wxCONFIG_USE_LOCAL_FILE 
wxCONFIG_USE_GLOBAL_FILE 
wxCONFIG_USE_RELATIVE_PATH 
wxCONFIG_USE_NO_ESCAPE_CHARACTERS 
wxCONFIG_USE_SUBDIR 

Use subdirectory for the local configuration file location.

Specifying this flag changes the default local configuration file location to ~/.appname/appname.conf. Please note that this path is not affected by layout set using wxStandardPaths::SetFileLayout() and it is recommended to use wxCONFIG_USE_XDG flag in addition to this file on contemporary Linux systems.

Since
2.8.2
wxCONFIG_USE_XDG 

Always use XDG-compliant file location on Unix systems.

If wxCONFIG_USE_SUBDIR is not specified, using this flag has the same effect as calling wxStandardPaths::SetFileLayout() with wxStandardPaths::FileLayout_XDG, i.e. it changes the default local configuration file location to ~/.config/appname.conf.

In combination with wxCONFIG_USE_SUBDIR, this flag changes the default configuration file location to ~/.config/appname/appname.conf`.

If neither this flag nor wxCONFIG_USE_HOME is specified, XDG-compliant configuration file path will be used by default, but if there is an existing file in the home directory, then it will continue to be used instead.

Since
3.3.0
wxCONFIG_USE_HOME 

Use home directory for the local file location on Unix systems.

Using this flag is not recommended, it exists only for compatibility with the previous wxWidgets versions which created configuration files in the home directory (i.e. ~/.appname) by default.

Note that any already existing files in the home directory will still be used, even if this file is not specified, unless wxCONFIG_USE_XDG is used.

Since
3.3.0