11aed263b7
Tue May 14 16:44:09 2002 Owen Taylor <otaylor@redhat.com> * gtk/gtklabel.c (gtk_label_ensure_layout): Set the width of the layout to the actual wrap width (our requisition) not the width we set when calculating the width. This results in the lines being justified within the correct area. (#79157, Anders Carlsson) * gtk/gtkaccelgroup.c gtk/gtkmarshelers.list: Corrected registered parameter types of "accel_activate" and "accel_changed" signals. (Patch from Murray Cumming, #78798) * gtk/gtkrc.c (gtk_rc_make_default_dir): Switch binary-version and type to correspond to the current ordering in _gtk_get_module_path. (#78746, Sergey Kuzminov) * gtk/gtkrc.c (gtk_rc_get_module_dir): Add docs pointing to the GTK_PATH documentation. * gtk/Makefile.am (uninstall-local): Delete key themes as well. (#81286, Kristian Rietveld.)
861 lines
25 KiB
Plaintext
861 lines
25 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Resource Files
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Routines for handling resource files
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para id="GtkRcStyle">
|
|
GTK+ provides resource file mechanism for configuring
|
|
various aspects of the operation of a GTK+ program
|
|
at runtime.
|
|
</para>
|
|
|
|
<refsect2><title>Default files</title>
|
|
<para>
|
|
An application can cause GTK+ to parse a specific RC
|
|
file by calling gtk_rc_parse(). In addition to this,
|
|
certain files will be read at the end of gtk_init().
|
|
Unless modified, the files looked for will be
|
|
<filename><SYSCONFDIR>/gtk-2.0/gtkrc</filename>
|
|
and <filename>.gtkrc-2.0</filename> in the users home directory.
|
|
(<filename><SYSCONFDIR></filename> defaults to
|
|
<filename>/usr/local/etc</filename>. It can be changed with the
|
|
<option>--prefix</option> or <option>--sysconfdir</option> options when
|
|
configuring GTK+.)
|
|
</para>
|
|
<para>
|
|
The set of these <firstterm>default</firstterm> files
|
|
can be retrieved with gtk_rc_get_default_files()
|
|
and modified with gtk_rc_add_default_file() and
|
|
gtk_rc_set_default_files().
|
|
Additionally, the <envar>GTK_RC_FILES</envar> 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.
|
|
</para>
|
|
<para><anchor id="locale-specific-rc">
|
|
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 <envar>LANG</envar> is set to <literal>ja_JP.ujis</literal>,
|
|
when loading the default file <filename>~/.gtkrc</filename> then GTK+ looks
|
|
for <filename>~/.gtkrc.ja_JP</filename> and <filename>~/.gtkrc.ja</filename>,
|
|
and parses the first of those that exists.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<refsect2><title>Pathnames and patterns</title>
|
|
<para>
|
|
A resource file defines a number of styles and key bindings and
|
|
attaches them to particular widgets. The attachment is done
|
|
by the <literal>widget</literal>, <literal>widget_class</literal>,
|
|
and <literal>class</literal> declarations. As an example
|
|
of such a statement:
|
|
<informalexample><programlisting>
|
|
widget "mywindow.*.GtkEntry" style "my-entry-class"
|
|
</programlisting></informalexample>
|
|
attaches the style <literal>"my-entry-class"</literal>
|
|
to all widgets whose <firstterm>widget class</firstterm>
|
|
matches the <firstterm>pattern</firstterm>
|
|
<literal>"mywindow.*.GtkEntry"</literal>.
|
|
</para>
|
|
<para>
|
|
The patterns here are given in the standard shell glob
|
|
syntax. The <literal>"?"</literal> wildcard matches
|
|
any character, while <literal>"*"</literal> matches
|
|
zero or more of any character. The three types of
|
|
matching are against the widget path, the
|
|
<firstterm>class path</firstterm> and the class
|
|
hierarchy. Both the widget and the class paths consists of a
|
|
<literal>"."</literal> separated list of all the
|
|
parents of the widget and the widget itself from
|
|
outermost to innermost. The difference is that in
|
|
the widget path, the name assigned by
|
|
gtk_widget_set_name() is used
|
|
if present, otherwise the class name of the widget, while
|
|
for the widget path, the class name is always used.
|
|
</para>
|
|
<para>
|
|
So, if you have a #GtkEntry named
|
|
<literal>"myentry"</literal>, inside of a of a window
|
|
named <literal>"mywindow"</literal>, then the
|
|
widget path is: <literal>"mwindow.GtkHBox.myentry"</literal>
|
|
while the class path is: <literal>"GtkWindow.GtkHBox.GtkEntry"</literal>.
|
|
</para>
|
|
<para>
|
|
Matching against class is a little different. The pattern
|
|
match is done against all class names in the widgets
|
|
class hierarchy (not the layout hierarchy) in sequence, so the
|
|
pattern:
|
|
<informalexample><programlisting>
|
|
class "GtkButton" style "my-style"
|
|
</programlisting></informalexample>
|
|
will match not just #GtkButton widgets,
|
|
but also #GtkToggleButton and
|
|
#GtkCheckButton widgets, since
|
|
those classes derive from #GtkButton.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<refsect2><title>Toplevel declarations</title>
|
|
<para>
|
|
An RC file is a text file which is composed of a sequence
|
|
of declarations. <literal>'#'</literal> characters delimit comments and
|
|
the portion of a line after a <literal>'#'</literal> is ignored when parsing
|
|
an RC file.
|
|
</para>
|
|
|
|
<para>
|
|
The possible toplevel declarations are:
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>binding <replaceable>name</replaceable>
|
|
{ ... }</literal></term>
|
|
<listitem>
|
|
<para>Declares a binding set.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>class <replaceable>pattern</replaceable>
|
|
[ style | binding [ : <replaceable>priority</replaceable> ]]
|
|
<replaceable>name</replaceable></literal></term>
|
|
<listitem>
|
|
<para>Specifies a style or binding set for a particular
|
|
branch of the inheritance hierarchy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>include <replaceable>filename</replaceable></literal></term>
|
|
<listitem>
|
|
<para>Parses another file at this point. If
|
|
<replaceable>filename</replaceable> is not an absolute filename,
|
|
it is searched in the directories of the currently open RC files.
|
|
</para>
|
|
<para>GTK+ also tries to load a
|
|
<link linkend="locale-specific-rc">locale-specific variant</link> of
|
|
the included file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>module_path <replaceable>path</replaceable></literal></term>
|
|
<listitem>
|
|
<para>Sets a path (a list of directories separated
|
|
by colons) that will be searched for theme engines referenced in
|
|
RC files.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>pixmap_path <replaceable>path</replaceable></literal></term>
|
|
<listitem>
|
|
<para>Sets a path (a list of directories separated
|
|
by colons) that will be searched for pixmaps referenced in
|
|
RC files.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>style <replaceable>name</replaceable> [ =
|
|
<replaceable>parent</replaceable> ] { ... }</literal></term>
|
|
<listitem>
|
|
<para>Declares a style.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>widget <replaceable>pattern</replaceable>
|
|
[ style | binding [ : <replaceable>priority</replaceable> ]]
|
|
<replaceable>name</replaceable></literal></term>
|
|
<listitem>
|
|
<para>Specifies a style or binding set for a particular
|
|
group of widgets by matching on the widget pathname.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>widget_class <replaceable>pattern</replaceable>
|
|
[ style | binding [ : <replaceable>priority</replaceable> ]]
|
|
<replaceable>name</replaceable></literal></term>
|
|
<listitem>
|
|
<para>Specifies a style or binding set for a particular
|
|
group of widgets by matching on the class pathname.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect2>
|
|
|
|
<refsect2><title>Styles</title>
|
|
<para>
|
|
A RC style is specified by a <literal>style</literal>
|
|
declaration in a RC file, and then bound to widgets
|
|
with a <literal>widget</literal>, <literal>widget_class</literal>,
|
|
or <literal>class</literal> declaration. All styles
|
|
applying to a particular widget are composited together
|
|
with <literal>widget</literal> declarations overriding
|
|
<literal>widget_class</literal> declarations which, in
|
|
turn, override <literal>class</literal> declarations.
|
|
Within each type of declaration, later declarations override
|
|
earlier ones.
|
|
</para>
|
|
|
|
<para>
|
|
Within a <literal>style</literal> declaration, the possible
|
|
elements are:
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>bg[<replaceable>state</replaceable>] =
|
|
<replaceable>color</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the color used for the background of most widgets.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>fg[<replaceable>state</replaceable>] =
|
|
<replaceable>color</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the color used for the foreground of most widgets.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>base[<replaceable>state</replaceable>] =
|
|
<replaceable>color</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the color used for the background of widgets displaying
|
|
editable text. This color is used for the background
|
|
of, among others, #GtkText, #GtkEntry, #GtkList, and #GtkClist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>text[<replaceable>state</replaceable>] =
|
|
<replaceable>color</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the color used for foreground of widgets using
|
|
<literal>base</literal> for the background color.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>bg_pixmap[<replaceable>state</replaceable>] =
|
|
<replaceable>pixmap</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets a background pixmap to be used in place of
|
|
the <literal>bg</literal> color (or for #GtkText,
|
|
in place of the <literal>base</literal> color. The special
|
|
value <literal>"<parent>"</literal> may be used to indicate that the widget should
|
|
use the same background pixmap as its parent. The special value
|
|
<literal>"<none>"</literal> may be used to indicate no background pixmap.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>font = <replaceable>font</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the font for a widget. <replaceable>font</replaceable> must be
|
|
a XLFD font description, e.g.
|
|
<literal>"-*-helvetica-medium-r-normal--10-*-*-*-*-*-*-*"</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>fontset = <replaceable>font</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the fontset for a widget. Overrides any
|
|
<literal>font</literal> declarations. <replaceable>font</replaceable>
|
|
must be a comma-separated list of XLFD font descriptions, e.g.
|
|
<literal>"-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240,
|
|
-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120,
|
|
-GB-Fixed-Medium-R-Normal--26-180-100-100-C-240,
|
|
-Adobe-Courier-Bold-R-Normal--25-180-100-100-M-150"</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>font_name = <replaceable>font</replaceable></literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the font for a widget. Overrides any
|
|
<literal>font</literal> or <literal>fontset</literal> declarations.
|
|
<replaceable>font</replaceable> must be a Pango font name, e.g.
|
|
<literal>"Sans Italic 10"</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>stock[<replaceable>"stock-id"</replaceable>] = { <replaceable>icon source specifications</replaceable> }</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Defines the icon for a stock item.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>engine <replaceable>"engine"</replaceable> { <replaceable>engine-specific
|
|
settings</replaceable> }</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Defines the engine to be used when drawing with this style.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
The colors and background pixmaps are specified as a function of the
|
|
state of the widget. The states are:
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>NORMAL</literal></term>
|
|
<listitem>
|
|
<para>
|
|
A color used for a widget in its normal state.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>ACTIVE</literal></term>
|
|
<listitem>
|
|
<para>
|
|
A variant of the <literal>NORMAL</literal> color used when the
|
|
widget is in the %GTK_STATE_ACTIVE state, and also for
|
|
the trough of a ScrollBar, tabs of a NoteBook
|
|
other than the current tab and similar areas.
|
|
Frequently, this should be a darker variant
|
|
of the <literal>NORMAL</literal> color.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>PRELIGHT</literal></term>
|
|
<listitem>
|
|
<para>
|
|
A color used for widgets in the %GTK_STATE_PRELIGHT state. This
|
|
state is the used for Buttons and MenuItems
|
|
that have the mouse cursor over them, and for
|
|
their children.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>SELECTED</literal></term>
|
|
<listitem>
|
|
<para>
|
|
A color used to highlight data selected by the user.
|
|
for instance, the selected items in a list widget, and the
|
|
selection in an editable widget.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>INSENSITIVE</literal></term>
|
|
<listitem>
|
|
<para>
|
|
A color used for the background of widgets that have
|
|
been set insensitive with gtk_widget_set_sensitive().
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
<para><anchor id="color-format">
|
|
Colors can be specified as a string containing a color name (GTK+ knows
|
|
all names from the X color database
|
|
<filename>/usr/lib/X11/rgb.txt</filename>),
|
|
in one of the hexadecimal forms <literal>&hash;rrrrggggbbbb</literal>,
|
|
<literal>&hash;rrrgggbbb</literal>, <literal>&hash;rrggbb</literal>,
|
|
or <literal>&hash;rgb</literal>, where <literal>r</literal>,
|
|
<literal>g</literal> and <literal>b</literal> are
|
|
hex digits, or they can be specified as a triplet
|
|
<literal>{ <replaceable>r</replaceable>, <replaceable>g</replaceable>,
|
|
<replaceable>b</replaceable>}</literal>, where <literal>r</literal>,
|
|
<literal>g</literal> and <literal>b</literal> are either integers in
|
|
the range 0-65635 or floats in the range 0.0-1.0.
|
|
</para>
|
|
|
|
<para>
|
|
In a <literal>stock</literal> definition, icon sources are specified as a
|
|
4-tuple of image filename, text direction, widget state, and size, in that
|
|
order. Each icon source specifies an image filename to use with a given
|
|
direction, state, and size. The <literal>*</literal> character can be used as a
|
|
wildcard, and if direction/state/size are omitted they default to
|
|
<literal>*</literal>. So for example, the following specifies different icons to
|
|
use for left-to-right and right-to-left languages:
|
|
<informalexample><programlisting>
|
|
stock["my-stock-item"] =
|
|
{
|
|
{ "itemltr.png", LTR, *, * },
|
|
{ "itemrtl.png", RTL, *, * }
|
|
}
|
|
</programlisting></informalexample>
|
|
This could be abbreviated as follows:
|
|
<informalexample><programlisting>
|
|
stock["my-stock-item"] =
|
|
{
|
|
{ "itemltr.png", LTR },
|
|
{ "itemrtl.png", RTL }
|
|
}
|
|
</programlisting></informalexample>
|
|
</para>
|
|
|
|
<para>
|
|
You can specify custom icons for specific sizes, as follows:
|
|
<informalexample><programlisting>
|
|
stock["my-stock-item"] =
|
|
{
|
|
{ "itemmenusize.png", *, *, "gtk-menu" },
|
|
{ "itemtoolbarsize.png", *, *, "gtk-large-toolbar" }
|
|
{ "itemgeneric.png" } /* implicit *, *, * as a fallback */
|
|
}
|
|
</programlisting></informalexample>
|
|
The sizes that come with GTK+ itself are <literal>"gtk-menu"</literal>,
|
|
<literal>"gtk-small-toolbar"</literal>, <literal>"gtk-large-toolbar"</literal>,
|
|
<literal>"gtk-button"</literal>, <literal>"gtk-dialog"</literal>. Applications
|
|
can define other sizes.
|
|
</para>
|
|
|
|
<para>
|
|
It's also possible to use custom icons for a given state, for example:
|
|
<informalexample><programlisting>
|
|
stock["my-stock-item"] =
|
|
{
|
|
{ "itemprelight.png", *, PRELIGHT },
|
|
{ "iteminsensitive.png", *, INSENSITIVE },
|
|
{ "itemgeneric.png" } /* implicit *, *, * as a fallback */
|
|
}
|
|
</programlisting></informalexample>
|
|
</para>
|
|
|
|
<para>
|
|
When selecting an icon source to use, GTK+ will consider text direction most
|
|
important, state second, and size third. It will select the best match based on
|
|
those criteria. If an attribute matches exactly (e.g. you specified
|
|
<literal>PRELIGHT</literal> or specified the size), GTK+ won't modify the image;
|
|
if the attribute matches with a wildcard, GTK+ will scale or modify the image to
|
|
match the state and size the user requested.
|
|
</para>
|
|
|
|
</refsect2>
|
|
|
|
<refsect2><title>Key bindings</title>
|
|
<para>
|
|
Key bindings allow the user to specify actions to be
|
|
taken on particular key presses. The form of a binding
|
|
set declaration is:
|
|
</para>
|
|
|
|
<informalexample><programlisting>
|
|
binding <replaceable>name</replaceable> {
|
|
bind <replaceable>key</replaceable> {
|
|
<replaceable>signalname</replaceable> (<replaceable>param</replaceable>, ...)
|
|
...
|
|
}
|
|
...
|
|
}
|
|
</programlisting></informalexample>
|
|
|
|
<para>
|
|
<replaceable>key</replaceable> is a string consisting of a
|
|
series of modifiers followed by the name of a key. The
|
|
modifiers can be:
|
|
<simplelist>
|
|
<member><literal><alt></literal></member>
|
|
<member><literal><control></literal></member>
|
|
<member><literal><mod1></literal></member>
|
|
<member><literal><mod2></literal></member>
|
|
<member><literal><mod3></literal></member>
|
|
<member><literal><mod4></literal></member>
|
|
<member><literal><mod5></literal></member>
|
|
<member><literal><release></literal></member>
|
|
<member><literal><shft></literal></member>
|
|
<member><literal><shift></literal></member>
|
|
</simplelist>
|
|
<literal><shft></literal> is an alias for
|
|
<literal><shift></literal> and
|
|
<literal><alt></literal> is an alias for
|
|
<literal><mod1></literal>.
|
|
</para>
|
|
|
|
<para>
|
|
The action that is bound to the key is a sequence
|
|
of signal names (strings) followed by parameters for
|
|
each signal. The signals must be action signals.
|
|
(See g_signal_new()). Each parameter can be
|
|
a float, integer, string, or unquoted string
|
|
representing an enumeration value. The types of
|
|
the parameters specified must match the types of the
|
|
parameters of the signal.
|
|
</para>
|
|
|
|
<para>
|
|
Binding sets are connected to widgets in the
|
|
same manner as styles, with one addition.
|
|
A priority can be specified for each pattern,
|
|
and within each type of pattern, binding sets
|
|
override other binding sets first by priority,
|
|
and only then by order of specification. (Later
|
|
overrides earlier). The priorities that can
|
|
be specified are (highest to lowest):
|
|
<simplelist>
|
|
<member><literal>highest</literal></member>
|
|
<member><literal>rc</literal></member>
|
|
<member><literal>theme</literal></member>
|
|
<member><literal>application</literal></member>
|
|
<member><literal>gtk</literal></member>
|
|
<member><literal>lowest</literal></member>
|
|
</simplelist>
|
|
<literal>rc</literal> is the default for bindings
|
|
read from an RC file, <literal>theme</literal>
|
|
is the default for bindings read from theme RC files,
|
|
<literal>application</literal>
|
|
should be used for bindings an application sets
|
|
up, and <literal>gtk</literal> is used for bindings
|
|
that GTK+ creates internally.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### 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_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_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>
|
|
Parses a color in the <link linkend="color-format">format</link> expected in a RC file.
|
|
</para>
|
|
|
|
@scanner: a #GtkScanner
|
|
@color: a pointer to a #GtkColor structure in which to store the result
|
|
@Returns: %G_TOKEN_NONE if parsing suceeded, otherwise the token
|
|
that was expected but not found.
|
|
|
|
|
|
<!-- ##### 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 suceeded, 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 suceeded, 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.
|
|
<!-- # Unused Parameters # -->
|
|
@context:
|
|
|
|
|
|
<!-- ##### 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
|
|
|
|
|
|
<!-- ##### 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
|
|
|
|
|