gtkrc.sgml

This GTK+ version 2.12.3. GTK+ is a multi-platform toolkit for creating graphical user interfaces.

</para>
</refsect2>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkRcStyle ##### -->
<para>
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.
</para>

@name: 
@bg_pixmap_name: 
@font_desc: 
@color_flags: 
@fg: 
@bg: 
@text: 
@base: 
@xthickness: 
@ythickness: 

<!-- ##### ENUM GtkRcFlags ##### -->
<para>
The #GtkRcFlags enumeration is used as a bitmask
to specify which fields of a #GtkRcStyle have been
set for each state.
</para>

@GTK_RC_FG: If present, the foreground color has been set for this state.
@GTK_RC_BG: If present, the background color has been set for this state.
@GTK_RC_TEXT: If present, the text color has been set for this state.
@GTK_RC_BASE: If present, the base color has been set for this state.

<!-- ##### ENUM GtkRcTokenType ##### -->
<para>
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.
</para>

@GTK_RC_TOKEN_INVALID: 
@GTK_RC_TOKEN_INCLUDE: 
@GTK_RC_TOKEN_NORMAL: 
@GTK_RC_TOKEN_ACTIVE: 
@GTK_RC_TOKEN_PRELIGHT: 
@GTK_RC_TOKEN_SELECTED: 
@GTK_RC_TOKEN_INSENSITIVE: 
@GTK_RC_TOKEN_FG: 
@GTK_RC_TOKEN_BG: 
@GTK_RC_TOKEN_TEXT: 
@GTK_RC_TOKEN_BASE: 
@GTK_RC_TOKEN_XTHICKNESS: 
@GTK_RC_TOKEN_YTHICKNESS: 
@GTK_RC_TOKEN_FONT: 
@GTK_RC_TOKEN_FONTSET: 
@GTK_RC_TOKEN_FONT_NAME: 
@GTK_RC_TOKEN_BG_PIXMAP: 
@GTK_RC_TOKEN_PIXMAP_PATH: 
@GTK_RC_TOKEN_STYLE: 
@GTK_RC_TOKEN_BINDING: 
@GTK_RC_TOKEN_BIND: 
@GTK_RC_TOKEN_WIDGET: 
@GTK_RC_TOKEN_WIDGET_CLASS: 
@GTK_RC_TOKEN_CLASS: 
@GTK_RC_TOKEN_LOWEST: 
@GTK_RC_TOKEN_GTK: 
@GTK_RC_TOKEN_APPLICATION: 
@GTK_RC_TOKEN_THEME: 
@GTK_RC_TOKEN_RC: 
@GTK_RC_TOKEN_HIGHEST: 
@GTK_RC_TOKEN_ENGINE: 
@GTK_RC_TOKEN_MODULE_PATH: 
@GTK_RC_TOKEN_IM_MODULE_PATH: 
@GTK_RC_TOKEN_IM_MODULE_FILE: 
@GTK_RC_TOKEN_STOCK: 
@GTK_RC_TOKEN_LTR: 
@GTK_RC_TOKEN_RTL: 
@GTK_RC_TOKEN_COLOR: 
@GTK_RC_TOKEN_UNBIND: 
@GTK_RC_TOKEN_LAST: 

<!-- ##### FUNCTION gtk_rc_scanner_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_rc_get_style ##### -->
<para>
</para>

@widget: 
@Returns: 


<!-- ##### FUNCTION gtk_rc_get_style_by_paths ##### -->
<para>

</para>

@settings: 
@widget_path: 
@class_path: 
@type: 
@Returns: 


<!-- ##### FUNCTION gtk_rc_add_widget_name_style ##### -->
<para>
Adds a #GtkRcStyle that will be looked up by a match against
the widget's pathname. This is equivalent to a:
<literal>
widget PATTERN style STYLE
</literal>
statement in a RC file.
</para>

@rc_style: the #GtkRcStyle to use for widgets matching @pattern
@pattern: the pattern


<!-- ##### FUNCTION gtk_rc_add_widget_class_style ##### -->
<para>
Adds a #GtkRcStyle that will be looked up by a match against
the widget's class pathname. This is equivalent to a:
<literal>
widget_class PATTERN style STYLE
</literal>
statement in a RC file.
</para>

@rc_style: the #GtkRcStyle to use for widgets matching @pattern
@pattern: the pattern


<!-- ##### FUNCTION gtk_rc_add_class_style ##### -->
<para>
Adds a #GtkRcStyle that will be looked up by a matching against
the class hierarchy of the widget. This is equivalent to a:
<literal>
class PATTERN style STYLE
</literal>
statement in a RC file.
</para>

@rc_style: the #GtkRcStyle to use for widgets deriving from @pattern
@pattern: the pattern


<!-- ##### FUNCTION gtk_rc_parse ##### -->
<para>
Parses a given resource file.
</para>

@filename: the filename of a file to parse. If @filename is not absolute, it
  is searched in the current directory.


<!-- ##### FUNCTION gtk_rc_parse_string ##### -->
<para>
Parses resource information directly from a string.
</para>

@rc_string: a string to parse.


<!-- ##### FUNCTION gtk_rc_reparse_all ##### -->
<para>
</para>

@Returns: 


<!-- ##### FUNCTION gtk_rc_reparse_all_for_settings ##### -->
<para>

</para>

@settings: 
@force_load: 
@Returns: 


<!-- ##### FUNCTION gtk_rc_reset_styles ##### -->
<para>

</para>

@settings: 


<!-- ##### FUNCTION gtk_rc_add_default_file ##### -->
<para>
</para>

@filename: 


<!-- ##### FUNCTION gtk_rc_get_default_files ##### -->
<para>
</para>

@Returns: 


<!-- ##### FUNCTION gtk_rc_set_default_files ##### -->
<para>
</para>

@filenames: 


<!-- ##### FUNCTION gtk_rc_parse_color ##### -->
<para>

</para>

@scanner: 
@color: 
@Returns: 


<!-- ##### FUNCTION gtk_rc_parse_color_full ##### -->
<para>

</para>

@scanner: 
@style: 
@color: 
@Returns: 


<!-- ##### FUNCTION gtk_rc_parse_state ##### -->
<para>
Parses a #GtkStateType variable from the format expected
in a RC file.
</para>

@scanner: a #GtkScanner (must be initialized for parsing an RC file)
@state: A pointer to a #GtkStateType variable in which to
store the result.
@Returns: %G_TOKEN_NONE if parsing succeeded, otherwise the token
that was expected but not found.


<!-- ##### FUNCTION gtk_rc_parse_priority ##### -->
<para>
Parses a #GtkPathPriorityType variable from the format expected
in a RC file.
</para>

@scanner: a #GtkScanner (must be initialized for parsing an RC file)
@priority: A pointer to #GtkPathPriorityType variable in which
to store the result.
@Returns: %G_TOKEN_NONE if parsing succeeded, otherwise the token
that was expected but not found.


<!-- ##### FUNCTION gtk_rc_find_module_in_path ##### -->
<para>
</para>

@module_file: The name of the module to search for.
@Returns: 


<!-- ##### FUNCTION gtk_rc_find_pixmap_in_path ##### -->
<para>
</para>

@settings: 
@scanner: a #GtkScanner. Used for printing out warning messages
if the file is not found.
@pixmap_file: The name of the file to search for.
@Returns: The filename, if found (must be freed with g_free()),
otherwise %NULL.


<!-- ##### FUNCTION gtk_rc_get_module_dir ##### -->
<para>
</para>

@Returns: 


<!-- ##### FUNCTION gtk_rc_get_im_module_path ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_rc_get_im_module_file ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_rc_get_theme_dir ##### -->
<para>
Returns the standard directory in which themes should
be installed. (GTK+ does not actually use this directory
itself.)
</para>

@Returns: The directory (must be freed with g_free()).


<!-- ##### FUNCTION gtk_rc_style_new ##### -->
<para>
Creates a new #GtkRcStyle with no fields set and
a reference count of 1.
</para>

@Returns: the newly-created #GtkRcStyle


<!-- ##### FUNCTION gtk_rc_style_copy ##### -->
<para>

</para>

@orig: 
@Returns: 


<!-- ##### FUNCTION gtk_rc_style_ref ##### -->
<para>
Increments the reference count of a #GtkRcStyle.
</para>

@rc_style: a #GtkRcStyle
@Deprecated: Use g_object_ref() instead


<!-- ##### FUNCTION gtk_rc_style_unref ##### -->
<para>
Decrements the reference count of a #GtkRcStyle and
frees if the result is 0.
</para>

@rc_style: a #GtkRcStyle
@Deprecated: Use g_object_unref() instead