Resource Files

Description

Routines for handling resource files

Methods and Functions

gtkRcScannerNew()
gtkRcGetStyle(object)
gtkRcGetStyleByPaths(settings, widget.path, class.path, type)
gtkRcAddWidgetNameStyle(object, pattern)
gtkRcAddWidgetClassStyle(object, pattern)
gtkRcAddClassStyle(object, pattern)
gtkRcParse(filename)
gtkRcParseString(rc.string)
gtkRcReparseAll()
gtkRcReparseAllForSettings(settings, force.load)
gtkRcResetStyles(settings)
gtkRcAddDefaultFile(filename)
gtkRcGetDefaultFiles()
gtkRcSetDefaultFiles(filenames)
gtkRcParseColor(scanner, color)
gtkRcParseState(scanner, state)
gtkRcParsePriority(scanner, priority)
gtkRcFindModuleInPath(module.file)
gtkRcFindPixmapInPath(settings, scanner = NULL, pixmap.file)
gtkRcGetModuleDir()
gtkRcGetImModulePath()
gtkRcGetImModuleFile()
gtkRcGetThemeDir()
gtkRcStyleNew()
gtkRcStyleCopy(object)

Hierarchy

  GObject
   +----GtkRcStyle

Detailed Description

GTK+ provides resource file mechanism for configuring various aspects of the operation of a GTK+ program at runtime.

Default files

An application can cause GTK+ to parse a specific RC file by calling gtkRcParse. In addition to this, certain files will be read at the end of gtkInit. Unless modified, the files looked for will be ‘<SYSCONFDIR>/gtk-2.0/gtkrc’ and ‘.gtkrc-2.0’ in the users home directory. (‘<SYSCONFDIR>’ defaults to ‘/usr/local/etc’. It can be changed with the --prefix or --sysconfdir options when configuring GTK+.) Note that although the filenames contain the version number 2.0, all 2.x versions of GTK+ look for these files.

The set of these default files can be retrieved with gtkRcGetDefaultFiles and modified with gtkRcAddDefaultFile and gtkRcSetDefaultFiles. Additionally, the GTK2_RC_FILES environment variable can be set to a G_SEARCHPATH_SEPARATOR_S-separated list of files in order to overwrite the set of default files at runtime.

For each RC file, in addition to the file itself, GTK+ will look for a locale-specific file that will be parsed after the main file. For instance, if LANG is set to ja_JP.ujis, when loading the default file ‘~/.gtkrc’ then GTK+ looks for ‘~/.gtkrc.ja_JP’ and ‘~/.gtkrc.ja’, and parses the first of those that exists.

Structures

GtkRcStyle

The GtkRcStyle structure is used to represent a set of information about the appearance of a widget. This can later be composited together with other GtkRcStyle structures to form a GtkStyle.

Enums and Flags

GtkRcFlags

The GtkRcFlags enumeration is used as a bitmask to specify which fields of a GtkRcStyle have been set for each state.

fg

If present, the foreground color has been set for this state.

bg

If present, the background color has been set for this state.

text

If present, the text color has been set for this state.

base

If present, the base color has been set for this state.

GtkRcTokenType

The GtkRcTokenType enumeration represents the tokens in the RC file. It is exposed so that theme engines can reuse these tokens when parsing the theme-engine specific portions of a RC file.

invalid

undocumented

include

undocumented

normal

undocumented

active

undocumented

prelight

undocumented

selected

undocumented

insensitive

undocumented

fg

undocumented

bg

undocumented

text

undocumented

base

undocumented

xthickness

undocumented

ythickness

undocumented

font

undocumented

fontset

undocumented

font-name

undocumented

bg-pixmap

undocumented

pixmap-path

undocumented

style

undocumented

binding

undocumented

bind

undocumented

widget

undocumented

widget-class

undocumented

class

undocumented

lowest

undocumented

gtk

undocumented

application

undocumented

theme

undocumented

rc

undocumented

highest

undocumented

engine

undocumented

module-path

undocumented

im-module-path

undocumented

im-module-file

undocumented

stock

undocumented

ltr

undocumented

rtl

undocumented

last

undocumented

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://developer.gnome.org/doc/API/2.0/gtk/gtk-Resource-Files.html