conf_help.h File Reference

'configuration helper' main header file for the X11 Work Bench Toolkit API More...

#include "platform_helper.h"

Go to the source code of this file.

Data Structures
struct	tagXSETTINGS_DATA_COLOR
	Structure for storing configuration color information, XSettingsTypeColor. More...
struct	tagCHXSetting
	Structure for storing settings information internally. More...
struct	tagCHXSettings
	Array wrapper for CHXSetting cache. More...
struct	tagCHXMLEntry
	Descriptor for parsed XML entry. More...

Macros
#define	GLOBAL_PATH   "/usr/local/etc"
#define	GLOBAL_XPATH   "/etc/X11"
#define	LOCAL_PATH   "~/.local/share/" /* the normal path for application-local files - was '~/' */
#define	CONFIG_PATH   "~/.config/" /* alternate path for config files */
#define	LOCAL_CONF_NAME   "settings"
#define	CH_OPEN_TIMEOUT   5000 /* wait up to 5000 milliseconds before timing out */
#define	CH_FLAGS_DEFAULT   0
#define	CH_FLAGS_GLOBAL   0x1
#define	CH_FLAGS_WRITE   0x2
#define	CHPARSEXML_DEFAULT   0
#define	CHPARSEXML_PAREN   1
#define	CHPARSEXML_BRACKET   2

Typedefs
typedef struct tagXSETTINGS_DATA_COLOR	XSETTINGS_DATA_COLOR
	Structure for storing configuration color information, XSettingsTypeColor. More...
typedef struct tagCHXSetting	CHXSetting
	Structure for storing settings information internally. More...
typedef struct tagCHXSettings	CHXSettings
	Array wrapper for CHXSetting cache. More...
typedef struct tagCHXMLEntry	CHXMLEntry
	Descriptor for parsed XML entry. More...

Enumerations
enum	XSettingsType {   XSettingsTypeInteger = 0,   XSettingsTypeString = 1,   XSettingsTypeColor = 2 }
	Enumeration for 'XSettingsType' which describes the type of setting being cached. More...

Functions
void	CHRegisterArgs (int argc, char **argv)
	registers arguments from the command line for later use More...
void	CHOnExit (void)
	frees resources used by Configuration 'helper' functions More...
const char *const *	CHGetArgV (void)
	retrieves the array of arguments stored by CHRegisterArgs() More...
int	CHGetArgC (void)
	retrieves the argument count stored by CHRegisterArgs() More...
int	CHGetResourceString (Display *pDisplay, const char *szIdentifier, char *szData, int cbData)
	Queries desktop resource strings (may become deprecated) More...
int	CHGetResourceInt (Display *pDisplay, const char *szIdentifier)
	Queryies desktop resource integer values (from strings) (may become deprecated) More...
void *	CHOpenConfFile (const char *szAppName, int iFlags)
	open configuration file for read/write, optionally creating it, based on application name More...
void	CHCloseConfFile (void *hFile)
	close configuration file opened by CHOpenConfFile(), but does NOT free memory resources More...
void	CHDestroyConfFile (void *hFile)
	destroy configuration file opened by CHOpenConfFile(), freeing memory resources (but not the files) More...
int	CHGetConfFileString (void *hFile, const char *szSection, const char *szIdentifier, char *szData, int cbData)
	obtain a string from a configuration file More...
int	CHWriteConfFileString (void *hFile, const char *szSection, const char *szIdentifier, const char *szData)
	write a string to a configuration file More...
int	CHGetConfFileInt (void *hFile, const char *szSection, const char *szIdentifier)
	obtain an integer value from a configuration file More...
int	CHWriteConfFileInt (void *hFile, const char *szSection, const char *szIdentifier, int iData)
	write an integer value to a configuration file More...
void	CHSettingsRefresh (Display *pDisplay)
	refresh the internally cached X settings More...
const CHXSettings *	CHGetXSettings (Display *pDisplay)
	returns a pointer to the cached X settings More...
const CHXSetting *	CHGetXSetting (Display *pDisplay, const char *szSettingName)
	returns a pointer to a specific X setting entry by name More...
int	CHGetDoubleClickTime (Display *pDisplay)
	returns default double click time (from X settings) More...
int	CHGetDoubleClickDistance (Display *pDisplay)
	returns default double click distance (from X settings) More...
int	CHGetDragThreshold (Display *pDisplay)
	returns default drag threshold (from X settings) More...
int	CHGetCursorBlink (Display *pDisplay)
	returns default cursor blink 'enable' flag (from X settings) More...
int	CHGetCursorBlinkTime (Display *pDisplay)
	returns default cursor blink time (from X settings) More...
const char *	CHGetBorderColor (Display *pDisplay)
	returns border color More...
const char *	CHGetStaticBackgroundColor (Display *pDisplay)
	returns background color for static elements More...
const char *	CHGetToolTipBackgroundColor (Display *pDisplay)
	returns background color for 'tool tips' More...
const char *	CHGetDialogBackgroundColor (Display *pDisplay)
	returns background color for dialog frame elements More...
const char *	CHGetActiveBackgroundColor (Display *pDisplay)
	returns background color for active elements More...
const char *	CHGetDisabledBackgroundColor (Display *pDisplay)
	returns background color for disabled (greyed) elements More...
const char *	CHGetBackgroundColor (Display *pDisplay)
	returns background color for non-static elements More...
const char *	CHGetDialogTextColor (Display *pDisplay)
	returns text color for dialog frame elements More...
const char *	CHGetActiveTextColor (Display *pDisplay)
	returns 'active' text color More...
const char *	CHGetDisabledTextColor (Display *pDisplay)
	returns 'disabled' (greyed) text color More...
const char *	CHGetToolTipTextColor (Display *pDisplay)
	returns text color for 'tool tips' More...
const char *	CHGetTextColor (Display *pDisplay)
	returns text color More...
const char *	CHGetHighlightForegroundColor (Display *pDisplay)
	returns highlight foreground color More...
const char *	CHGetHighlightBackgroundColor (Display *pDisplay)
	returns highlight background color More...
CHXMLEntry *	CHParseXML (const char *pXMLData, int cbLength)
	Parses contents of an XML tag, returning as WBAlloc'd string list similar to environment strings. More...
void	CHDebugDumpXML (CHXMLEntry *pEntry)
	Parses contents of an XML tag, returning as WBAlloc'd string list similar to environment strings. More...
char *	CHParseXMLTagContents (const char *pTagContents, int cbLength)
	Parses contents of a single XML tag, returning as WBAlloc'd string list similar to environment strings. More...
const char *	CHFindNextXMLTag (const char *pTagContents, int cbLength, int nNestingFlags)
	Parses contents of a XML to find the next tag, skipping comments along the way. More...
const char *	CHFindEndOfXMLTag (const char *pTagContents, int cbLength)
	Parses contents of an XML tag to find the end of it. More...
const char *	CHFindEndOfXMLSection (const char *pTagContents, int cbLength, char cEndChar, int bUseQuotes)
	Parses XML text for the end of a 'section', typically ending in '>' ')' or ']'. More...
char *	CHGetFileMimeType (const char *szFileName)
	Get the MIME type for a particular file name or extension. More...
char *	CHGetMimeDefaultApp (const char *szMimeType)
	Get the default application for a particular MIME type. More...
char *	CHGetDesktopFileInfo (const char *szDesktopFile, const char *szInfo)
	Get the default application for a particular MIME type. More...
void	CHDumpConfig (void)
	dump config information using debug output functions More...

Detailed Description

'configuration helper' main header file for the X11 Work Bench Toolkit API

X11 Work Bench Toolkit Toolkit API

Definition in file conf_help.h.