forked from AuroraMiddleware/gtk
docs: use ` instead of <literal>
This commit is contained in:
parent
76447c3512
commit
a22358c0c0
@ -434,7 +434,7 @@ gdk_init_check (int *argc,
|
||||
*
|
||||
* Initializes the GDK library and connects to the windowing system.
|
||||
* If initialization fails, a warning message is output and the application
|
||||
* terminates with a call to <literal>exit(1)</literal>.
|
||||
* terminates with a call to `exit(1)`.
|
||||
*
|
||||
* Any arguments used by GDK are removed from the array and @argc and @argv
|
||||
* are updated accordingly.
|
||||
@ -1115,7 +1115,7 @@ gdk_get_program_class (void)
|
||||
* @program_class: a string.
|
||||
*
|
||||
* Sets the program class. The X11 backend uses the program class to set
|
||||
* the class name part of the <literal>WM_CLASS</literal> property on
|
||||
* the class name part of the `WM_CLASS` property on
|
||||
* toplevel windows; see the ICCCM.
|
||||
*/
|
||||
void
|
||||
|
@ -164,8 +164,8 @@ gdk_color_parse (const gchar *spec,
|
||||
* @color: a #GdkColor
|
||||
*
|
||||
* Returns a textual specification of @color in the hexadecimal form
|
||||
* <literal>#rrrrggggbbbb</literal>, where <literal>r</literal>,
|
||||
* <literal>g</literal> and <literal>b</literal> are hex digits
|
||||
* `#rrrrggggbbbb`, where `r`,
|
||||
* `g` and `b` are hex digits
|
||||
* representing the red, green and blue components respectively.
|
||||
*
|
||||
* The returned string can be parsed by gdk_color_parse().
|
||||
|
@ -296,9 +296,9 @@ gdk_cursor_new_from_name (GdkDisplay *display,
|
||||
* gdk_display_get_maximal_cursor_size() give information about
|
||||
* cursor sizes.
|
||||
*
|
||||
* If @x or @y are <literal>-1</literal>, the pixbuf must have
|
||||
* If @x or @y are `-1`, the pixbuf must have
|
||||
* options named "x_hot" and "y_hot", resp., containing
|
||||
* integer values between <literal>0</literal> and the width resp. height of
|
||||
* integer values between `0` and the width resp. height of
|
||||
* the pixbuf. (Since: 3.0)
|
||||
*
|
||||
* On the X backend, support for RGBA cursors requires a
|
||||
|
@ -328,8 +328,8 @@ gdk_display_manager_get_default_display (GdkDisplayManager *manager)
|
||||
* gdk_display_get_default:
|
||||
*
|
||||
* Gets the default #GdkDisplay. This is a convenience
|
||||
* function for
|
||||
* <literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
|
||||
* function for:
|
||||
* `gdk_display_manager_get_default_display (gdk_display_manager_get ())`.
|
||||
*
|
||||
* Returns: (transfer none): a #GdkDisplay, or %NULL if there is no default
|
||||
* display.
|
||||
|
@ -1914,12 +1914,12 @@ gdk_event_set_screen (GdkEvent *event,
|
||||
* @event: a #GdkEvent
|
||||
*
|
||||
* Returns the screen for the event. The screen is
|
||||
* typically the screen for <literal>event->any.window</literal>, but
|
||||
* typically the screen for `event->any.window`, but
|
||||
* for events such as mouse events, it is the screen
|
||||
* where the pointer was when the event occurs -
|
||||
* that is, the screen which has the root window
|
||||
* to which <literal>event->motion.x_root</literal> and
|
||||
* <literal>event->motion.y_root</literal> are relative.
|
||||
* to which `event->motion.x_root` and
|
||||
* `event->motion.y_root` are relative.
|
||||
*
|
||||
* Return value: (transfer none): the screen for the event
|
||||
*
|
||||
|
@ -176,7 +176,7 @@ typedef void GdkXEvent; /* Can be cast to window system specific
|
||||
* GdkFilterReturn:
|
||||
* @GDK_FILTER_CONTINUE: event not handled, continue processing.
|
||||
* @GDK_FILTER_TRANSLATE: native event translated into a GDK event and stored
|
||||
* in the <literal>event</literal> structure that was passed in.
|
||||
* in the `event` structure that was passed in.
|
||||
* @GDK_FILTER_REMOVE: event handled, terminate processing.
|
||||
*
|
||||
* Specifies the result of applying a #GdkFilterFunc to a native event.
|
||||
@ -199,7 +199,7 @@ typedef enum {
|
||||
* converted to GDK events.
|
||||
*
|
||||
* When a filter is called, @event is unpopulated, except for
|
||||
* <literal>event->window</literal>. The filter may translate the native
|
||||
* `event->window`. The filter may translate the native
|
||||
* event to a GDK event and store the result in @event, or handle it without
|
||||
* translation. If the filter translates the event and processing should
|
||||
* continue, it should return %GDK_FILTER_TRANSLATE.
|
||||
@ -285,7 +285,7 @@ typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent,
|
||||
*
|
||||
* In some language bindings, the values %GDK_2BUTTON_PRESS and
|
||||
* %GDK_3BUTTON_PRESS would translate into something syntactically
|
||||
* invalid (eg <literal>Gdk.EventType.2ButtonPress</literal>, where a
|
||||
* invalid (eg `Gdk.EventType.2ButtonPress`, where a
|
||||
* symbol is not allowed to start with a number). In that case, the
|
||||
* aliases %GDK_DOUBLE_BUTTON_PRESS and %GDK_TRIPLE_BUTTON_PRESS can
|
||||
* be used instead.
|
||||
|
@ -497,9 +497,9 @@ gdk_keymap_lookup_key (GdkKeymap *keymap,
|
||||
*
|
||||
* @consumed_modifiers gives modifiers that should be masked out
|
||||
* from @state when comparing this key press to a hot key. For
|
||||
* instance, on a US keyboard, the <literal>plus</literal>
|
||||
* instance, on a US keyboard, the `plus`
|
||||
* symbol is shifted, so when comparing a key press to a
|
||||
* <literal><Control>plus</literal> accelerator <Shift> should
|
||||
* `<Control>plus` accelerator <Shift> should
|
||||
* be masked out.
|
||||
*
|
||||
* |[<!-- language="C" -->
|
||||
@ -525,16 +525,16 @@ gdk_keymap_lookup_key (GdkKeymap *keymap,
|
||||
* ]|
|
||||
*
|
||||
* However, this did not work if multi-modifier combinations were
|
||||
* used in the keymap, since, for instance, <literal><Control></literal>
|
||||
* would be masked out even if only <literal><Control><Alt></literal>
|
||||
* used in the keymap, since, for instance, `<Control>`
|
||||
* would be masked out even if only `<Control><Alt>`
|
||||
* was used in the keymap. To support this usage as well as well as
|
||||
* possible, all single modifier combinations
|
||||
* that could affect the key for any combination of modifiers will
|
||||
* be returned in @consumed_modifiers; multi-modifier combinations
|
||||
* are returned only when actually found in @state. When you store
|
||||
* accelerators, you should always store them with consumed modifiers
|
||||
* removed. Store <literal><Control>plus</literal>,
|
||||
* not <literal><Control><Shift>plus</literal>,
|
||||
* removed. Store `<Control>plus`,
|
||||
* not `<Control><Shift>plus`,
|
||||
*
|
||||
* Return value: %TRUE if there was a keyval bound to the keycode/state/group
|
||||
**/
|
||||
|
@ -330,8 +330,8 @@ gdk_rgba_equal (gconstpointer p1,
|
||||
* @rgba: a #GdkRGBA
|
||||
*
|
||||
* Returns a textual specification of @rgba in the form
|
||||
* <literal>rgb (r, g, b)</literal> or
|
||||
* <literal>rgba (r, g, b, a)</literal>,
|
||||
* `rgb (r, g, b)` or
|
||||
* `rgba (r, g, b, a)`,
|
||||
* where 'r', 'g', 'b' and 'a' represent the red, green,
|
||||
* blue and alpha values respectively. r, g, and b are
|
||||
* represented as integers in the range 0 to 255, and a
|
||||
|
@ -40,12 +40,12 @@
|
||||
* a named clipboard, identified by a string interned as a #GdkAtom. By
|
||||
* claiming ownership of a selection, an application indicates that it will
|
||||
* be responsible for supplying its contents. The most common selections are
|
||||
* <literal>PRIMARY</literal> and <literal>CLIPBOARD</literal>.
|
||||
* `PRIMARY` and `CLIPBOARD`.
|
||||
*
|
||||
* The contents of a selection can be represented in a number of formats,
|
||||
* called “targets”. Each target is identified by an atom.
|
||||
* A list of all possible targets supported by the selection owner can be
|
||||
* retrieved by requesting the special target <literal>TARGETS</literal>. When
|
||||
* retrieved by requesting the special target `TARGETS`. When
|
||||
* a selection is retrieved, the data is accompanied by a type (an atom), and
|
||||
* a format (an integer, representing the number of bits per item).
|
||||
* See <link linkend="gdk3-Properties-and-Atoms">Properties and Atoms</link>
|
||||
@ -54,7 +54,7 @@
|
||||
* The functions in this section only contain the lowlevel parts of the
|
||||
* selection protocol. A considerably more complicated implementation is needed
|
||||
* on top of this. GTK+ contains such an implementation in the functions in
|
||||
* <literal>gtkselection.h</literal> and programmers should use those functions
|
||||
* `gtkselection.h` and programmers should use those functions
|
||||
* instead of the ones presented here. If you plan to implement selection
|
||||
* handling directly on top of the functions here, you should refer to the
|
||||
* X Inter-client Communication Conventions Manual (ICCCM).
|
||||
|
@ -40,112 +40,112 @@ G_BEGIN_DECLS
|
||||
/**
|
||||
* GDK_SELECTION_PRIMARY:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>PRIMARY</literal> selection.
|
||||
* A #GdkAtom representing the `PRIMARY` selection.
|
||||
*/
|
||||
#define GDK_SELECTION_PRIMARY _GDK_MAKE_ATOM (1)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_SECONDARY:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>SECONDARY</literal> selection.
|
||||
* A #GdkAtom representing the `SECONDARY` selection.
|
||||
*/
|
||||
#define GDK_SELECTION_SECONDARY _GDK_MAKE_ATOM (2)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_CLIPBOARD:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>CLIPBOARD</literal> selection.
|
||||
* A #GdkAtom representing the `CLIPBOARD` selection.
|
||||
*/
|
||||
#define GDK_SELECTION_CLIPBOARD _GDK_MAKE_ATOM (69)
|
||||
|
||||
/**
|
||||
* GDK_TARGET_BITMAP:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>BITMAP</literal> selection target.
|
||||
* A #GdkAtom representing the `BITMAP` selection target.
|
||||
*/
|
||||
#define GDK_TARGET_BITMAP _GDK_MAKE_ATOM (5)
|
||||
|
||||
/**
|
||||
* GDK_TARGET_COLORMAP:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>COLORMAP</literal> selection target.
|
||||
* A #GdkAtom representing the `COLORMAP` selection target.
|
||||
*/
|
||||
#define GDK_TARGET_COLORMAP _GDK_MAKE_ATOM (7)
|
||||
|
||||
/**
|
||||
* GDK_TARGET_DRAWABLE:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>DRAWABLE</literal> selection target.
|
||||
* A #GdkAtom representing the `DRAWABLE` selection target.
|
||||
*/
|
||||
#define GDK_TARGET_DRAWABLE _GDK_MAKE_ATOM (17)
|
||||
|
||||
/**
|
||||
* GDK_TARGET_PIXMAP:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>PIXMAP</literal> selection target.
|
||||
* A #GdkAtom representing the `PIXMAP` selection target.
|
||||
*/
|
||||
#define GDK_TARGET_PIXMAP _GDK_MAKE_ATOM (20)
|
||||
|
||||
/**
|
||||
* GDK_TARGET_STRING:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>STRING</literal> selection target.
|
||||
* A #GdkAtom representing the `STRING` selection target.
|
||||
*/
|
||||
#define GDK_TARGET_STRING _GDK_MAKE_ATOM (31)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_ATOM:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>ATOM</literal> selection type.
|
||||
* A #GdkAtom representing the `ATOM` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_ATOM _GDK_MAKE_ATOM (4)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_BITMAP:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>BITMAP</literal> selection type.
|
||||
* A #GdkAtom representing the `BITMAP` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_BITMAP _GDK_MAKE_ATOM (5)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_COLORMAP:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>COLORMAP</literal> selection type.
|
||||
* A #GdkAtom representing the `COLORMAP` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_COLORMAP _GDK_MAKE_ATOM (7)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_DRAWABLE:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>DRAWABLE</literal> selection type.
|
||||
* A #GdkAtom representing the `DRAWABLE` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_DRAWABLE _GDK_MAKE_ATOM (17)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_INTEGER:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>INTEGER</literal> selection type.
|
||||
* A #GdkAtom representing the `INTEGER` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_INTEGER _GDK_MAKE_ATOM (19)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_PIXMAP:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>PIXMAP</literal> selection type.
|
||||
* A #GdkAtom representing the `PIXMAP` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_PIXMAP _GDK_MAKE_ATOM (20)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_WINDOW:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>WINDOW</literal> selection type.
|
||||
* A #GdkAtom representing the `WINDOW` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_WINDOW _GDK_MAKE_ATOM (33)
|
||||
|
||||
/**
|
||||
* GDK_SELECTION_TYPE_STRING:
|
||||
*
|
||||
* A #GdkAtom representing the <literal>STRING</literal> selection type.
|
||||
* A #GdkAtom representing the `STRING` selection type.
|
||||
*/
|
||||
#define GDK_SELECTION_TYPE_STRING _GDK_MAKE_ATOM (31)
|
||||
|
||||
|
@ -108,7 +108,7 @@ typedef struct _GdkAtom *GdkAtom;
|
||||
* GDK_NONE:
|
||||
*
|
||||
* A null value for #GdkAtom, used in a similar way as
|
||||
* <literal>None</literal> in the Xlib API.
|
||||
* `None` in the Xlib API.
|
||||
*/
|
||||
#define GDK_NONE _GDK_MAKE_ATOM (0)
|
||||
|
||||
|
@ -10658,9 +10658,9 @@ gdk_property_get (GdkWindow *window,
|
||||
* must match the existing format or an error will occur.
|
||||
* @mode: a value describing how the new data is to be combined
|
||||
* with the current data.
|
||||
* @data: the data (a <literal>guchar *</literal>
|
||||
* <literal>gushort *</literal>, or <literal>gulong *</literal>,
|
||||
* depending on @format), cast to a <literal>guchar *</literal>.
|
||||
* @data: the data (a `guchar *`
|
||||
* `gushort *`, or `gulong *`,
|
||||
* depending on @format), cast to a `guchar *`.
|
||||
* @nelements: the number of elements of size determined by the format,
|
||||
* contained in @data.
|
||||
*
|
||||
|
@ -40,10 +40,10 @@
|
||||
* @Title: Wayland Interaction
|
||||
*
|
||||
* The functions in this section are specific to the GDK Wayland backend.
|
||||
* To use them, you need to include the <literal><gdk/gdkwayland.h></literal>
|
||||
* To use them, you need to include the `<gdk/gdkwayland.h>`
|
||||
* header and use the Wayland-specific pkg-config files to build your
|
||||
* application (either <literal>gdk-wayland-3.0</literal> or
|
||||
* <literal>gtk+-wayland-3.0</literal>).
|
||||
* application (either `gdk-wayland-3.0` or
|
||||
* `gtk+-wayland-3.0`).
|
||||
*
|
||||
* To make your code compile with other GDK backends, guard backend-specific
|
||||
* calls by an ifdef as follows. Since GDK may be built with multiple
|
||||
|
@ -2441,7 +2441,7 @@ gdk_x11_display_list_devices (GdkDisplay *display)
|
||||
* @n_events: number of event type codes to register
|
||||
*
|
||||
* Registers interest in receiving extension events with type codes
|
||||
* between @event_base and <literal>event_base + n_events - 1</literal>.
|
||||
* between @event_base and `event_base + n_events - 1`.
|
||||
* The registered events must have the window field in the same place
|
||||
* as core X events (this is not the case for e.g. XKB extension events).
|
||||
*
|
||||
@ -2788,7 +2788,7 @@ gdk_x11_display_error_trap_pop_ignored (GdkDisplay *display)
|
||||
* @sm_client_id: the client id assigned by the session manager when the
|
||||
* connection was opened, or %NULL to remove the property.
|
||||
*
|
||||
* Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
|
||||
* Sets the `SM_CLIENT_ID` property on the application's leader window so that
|
||||
* the window manager can save the application's state using the X11R6 ICCCM
|
||||
* session management protocol.
|
||||
*
|
||||
|
@ -52,10 +52,10 @@
|
||||
* @Title: X Window System Interaction
|
||||
*
|
||||
* The functions in this section are specific to the GDK X11 backend.
|
||||
* To use them, you need to include the <literal><gdk/gdkx.h></literal>
|
||||
* To use them, you need to include the `<gdk/gdkx.h>`
|
||||
* header and use the X11-specific pkg-config files to build your
|
||||
* application (either <literal>gdk-x11-3.0</literal> or
|
||||
* <literal>gtk+-x11-3.0</literal>).
|
||||
* application (either `gdk-x11-3.0` or
|
||||
* `gtk+-x11-3.0`).
|
||||
*
|
||||
* To make your code compile with other GDK backends, guard backend-specific
|
||||
* calls by an ifdef as follows. Since GDK may be built with multiple
|
||||
|
@ -48,7 +48,7 @@
|
||||
*
|
||||
* Accelerators are handled by the GTK+ accelerator map. All actions are
|
||||
* assigned an accelerator path (which normally has the form
|
||||
* <literal><Actions>/group-name/action-name</literal>)
|
||||
* `<Actions>/group-name/action-name`)
|
||||
* and a shortcut is associated with this accelerator path. All menuitems
|
||||
* and toolitems take on this accelerator path. The GTK+ accelerator map
|
||||
* code makes sure that the correct shortcut is displayed next to the menu
|
||||
@ -918,7 +918,7 @@ check_unique_action (GtkActionGroup *action_group,
|
||||
* if a user tries to modify the accelerator of a menuitem associated with
|
||||
* the action. Therefore you must either set the accel path yourself with
|
||||
* gtk_action_set_accel_path(), or use
|
||||
* <literal>gtk_action_group_add_action_with_accel (..., NULL)</literal>.
|
||||
* `gtk_action_group_add_action_with_accel (..., NULL)`.
|
||||
*
|
||||
* Since: 2.4
|
||||
*
|
||||
@ -965,7 +965,7 @@ gtk_action_group_add_action (GtkActionGroup *action_group,
|
||||
* with the stock_id of the action.
|
||||
*
|
||||
* Accel paths are set to
|
||||
* <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
|
||||
* `<Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
|
||||
*
|
||||
* Since: 2.4
|
||||
*
|
||||
@ -1110,7 +1110,7 @@ gtk_action_group_list_actions (GtkActionGroup *action_group)
|
||||
*
|
||||
* The "activate" signals of the actions are connected to the callbacks and
|
||||
* their accel paths are set to
|
||||
* <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
|
||||
* `<Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
|
||||
*
|
||||
* Since: 2.4
|
||||
*
|
||||
@ -1245,7 +1245,7 @@ gtk_action_group_add_actions_full (GtkActionGroup *action_group,
|
||||
*
|
||||
* The "activate" signals of the actions are connected to the callbacks and
|
||||
* their accel paths are set to
|
||||
* <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
|
||||
* `<Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
|
||||
*
|
||||
* Since: 2.4
|
||||
*
|
||||
@ -1365,7 +1365,7 @@ gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_gro
|
||||
*
|
||||
* The "changed" signal of the first radio action is connected to the
|
||||
* @on_change callback and the accel paths of the actions are set to
|
||||
* <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
|
||||
* `<Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
|
||||
*
|
||||
* Since: 2.4
|
||||
*
|
||||
|
@ -100,7 +100,7 @@
|
||||
* <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 `LANG` is set to <literal>ja_JP.ujis</literal>,
|
||||
* 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.
|
||||
@ -109,44 +109,44 @@
|
||||
*
|
||||
* 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
|
||||
* by the `widget`, `widget_class`,
|
||||
* and `class` declarations. As an example
|
||||
* of such a statement:
|
||||
*
|
||||
* |[
|
||||
* widget "mywindow.*.GtkEntry" style "my-entry-class"
|
||||
* ]|
|
||||
*
|
||||
* attaches the style <literal>"my-entry-class"</literal> to all
|
||||
* attaches the style `"my-entry-class"` to all
|
||||
* widgets whose “widget path” matches the
|
||||
* “pattern” <literal>"mywindow.*.GtkEntry"</literal>.
|
||||
* “pattern” `"mywindow.*.GtkEntry"`.
|
||||
* That is, all #GtkEntry widgets which are part of a #GtkWindow named
|
||||
* <literal>"mywindow"</literal>.
|
||||
* `"mywindow"`.
|
||||
*
|
||||
* 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 `"?"` wildcard matches any character, while
|
||||
* `"*"` matches zero or more of any character.
|
||||
* The three types of matching are against the widget path, the
|
||||
* “class path” and the class hierarchy. Both the
|
||||
* widget path and the class path consist of a <literal>"."</literal>
|
||||
* widget path and the class path consist of a `"."`
|
||||
* 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 class path, the class name is
|
||||
* always used.
|
||||
*
|
||||
* Since GTK+ 2.10, <literal>widget_class</literal> paths can also contain
|
||||
* <literal><classname></literal> substrings, which are matching
|
||||
* Since GTK+ 2.10, `widget_class` paths can also contain
|
||||
* `<classname>` substrings, which are matching
|
||||
* the class with the given name and any derived classes. For instance,
|
||||
* |[
|
||||
* widget_class "*<GtkMenuItem>.GtkLabel" style "my-style"
|
||||
* ]|
|
||||
* will match #GtkLabel widgets which are contained in any kind of menu item.
|
||||
*
|
||||
* So, if you have a #GtkEntry named <literal>"myentry"</literal>, inside of a
|
||||
* horizontal box in a window named <literal>"mywindow"</literal>, then the
|
||||
* widget path is: <literal>"mywindow.GtkHBox.myentry"</literal>
|
||||
* while the class path is: <literal>"GtkWindow.GtkHBox.GtkEntry"</literal>.
|
||||
* So, if you have a #GtkEntry named `"myentry"`, inside of a
|
||||
* horizontal box in a window named `"mywindow"`, then the
|
||||
* widget path is: `"mywindow.GtkHBox.myentry"`
|
||||
* while the class path is: `"GtkWindow.GtkHBox.GtkEntry"`.
|
||||
*
|
||||
* Matching against class is a little different. The pattern match is done
|
||||
* against all class names in the widgets class hierarchy (not the layout
|
||||
@ -162,24 +162,24 @@
|
||||
* by order of specification (later overrides earlier). The priorities
|
||||
* that can be specified are (highest to lowest):
|
||||
*
|
||||
* - <literal>highest</literal>
|
||||
* - `highest`
|
||||
*
|
||||
* - <literal>rc</literal>
|
||||
* - `rc`
|
||||
*
|
||||
* - <literal>theme</literal>
|
||||
* - `theme`
|
||||
*
|
||||
* - <literal>application</literal>
|
||||
* - `application`
|
||||
*
|
||||
* - <literal>gtk</literal>
|
||||
* - `gtk`
|
||||
*
|
||||
* - <literal>lowest</literal>
|
||||
* - `lowest`
|
||||
*
|
||||
* <literal>rc</literal> is the default for styles
|
||||
* read from an RC file, <literal>theme</literal>
|
||||
* `rc` is the default for styles
|
||||
* read from an RC file, `theme`
|
||||
* is the default for styles read from theme RC files,
|
||||
* <literal>application</literal>
|
||||
* `application`
|
||||
* should be used for styles an application sets
|
||||
* up, and <literal>gtk</literal> is used for styles
|
||||
* up, and `gtk` is used for styles
|
||||
* that GTK+ creates internally.
|
||||
*
|
||||
* # Theme gtkrc files #
|
||||
@ -230,46 +230,46 @@
|
||||
* match to a single integer comparison in most cases.
|
||||
*
|
||||
* 4. To avoid complex recursive matching, specification of full class names
|
||||
* (for <literal>class</literal> matches) or full path names (for
|
||||
* <literal>widget</literal> and <literal>widget_class</literal> matches)
|
||||
* (for `class` matches) or full path names (for
|
||||
* `widget` and `widget_class` matches)
|
||||
* is to be preferred over shortened names
|
||||
* containing <literal>"*"</literal> or <literal>"?"</literal>.
|
||||
* containing `"*"` or `"?"`.
|
||||
*
|
||||
* 5. If at all necessary, wildcards should only be used at the tail or head
|
||||
* of a pattern. This reduces the match complexity to a string comparison
|
||||
* per RC style.
|
||||
*
|
||||
* 6. When using wildcards, use of <literal>"?"</literal> should be preferred
|
||||
* over <literal>"*"</literal>. This can reduce the matching complexity from
|
||||
* O(n^2) to O(n). For example <literal>"Gtk*Box"</literal> can be turned into
|
||||
* <literal>"Gtk?Box"</literal> and will still match #GtkHBox and #GtkVBox.
|
||||
* 6. When using wildcards, use of `"?"` should be preferred
|
||||
* over `"*"`. This can reduce the matching complexity from
|
||||
* O(n^2) to O(n). For example `"Gtk*Box"` can be turned into
|
||||
* `"Gtk?Box"` and will still match #GtkHBox and #GtkVBox.
|
||||
*
|
||||
* 7. The use of <literal>"*"</literal> wildcards should be restricted as much
|
||||
* as possible, because matching <literal>"A*B*C*RestString"</literal> can
|
||||
* 7. The use of `"*"` wildcards should be restricted as much
|
||||
* as possible, because matching `"A*B*C*RestString"` can
|
||||
* result in matching complexities of O(n^2) worst case.
|
||||
*
|
||||
* # Toplevel declarations #
|
||||
*
|
||||
* 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
|
||||
* of declarations. `'#'` characters delimit comments and
|
||||
* the portion of a line after a `'#'` is ignored when parsing
|
||||
* an RC file.
|
||||
*
|
||||
* The possible toplevel declarations are:
|
||||
*
|
||||
* * <literal>binding <replaceable>name</replaceable>
|
||||
* { ... }</literal>
|
||||
* * `binding <replaceable>name</replaceable>
|
||||
* { ... }`
|
||||
*
|
||||
* Declares a binding set.
|
||||
*
|
||||
* * <literal>class <replaceable>pattern</replaceable>
|
||||
* * `class <replaceable>pattern</replaceable>
|
||||
* [ style | binding ][ : <replaceable>priority</replaceable> ]
|
||||
* <replaceable>name</replaceable></literal>
|
||||
* <replaceable>name</replaceable>`
|
||||
*
|
||||
* Specifies a style or binding set for a particular
|
||||
* branch of the inheritance hierarchy.
|
||||
*
|
||||
* * <literal>include <replaceable>filename</replaceable></literal>
|
||||
* * `include <replaceable>filename</replaceable>`
|
||||
*
|
||||
* Parses another file at this point. If
|
||||
* <replaceable>filename</replaceable> is not an absolute filename,
|
||||
@ -279,39 +279,39 @@
|
||||
* <link linkend="locale-specific-rc">locale-specific variant</link> of
|
||||
* the included file.
|
||||
*
|
||||
* * <literal>module_path <replaceable>path</replaceable></literal>
|
||||
* * `module_path <replaceable>path</replaceable>`
|
||||
*
|
||||
* Sets a path (a list of directories separated
|
||||
* by colons) that will be searched for theme engines referenced in
|
||||
* RC files.
|
||||
*
|
||||
* * <literal>pixmap_path <replaceable>path</replaceable></literal>
|
||||
* * `pixmap_path <replaceable>path</replaceable>`
|
||||
*
|
||||
* Sets a path (a list of directories separated
|
||||
* by colons) that will be searched for pixmaps referenced in
|
||||
* RC files.
|
||||
*
|
||||
* * <literal>im_module_file <replaceable>pathname</replaceable></literal>
|
||||
* * `im_module_file <replaceable>pathname</replaceable>`
|
||||
*
|
||||
* Sets the pathname for the IM modules file. Setting this from RC files
|
||||
* is deprecated; you should use the environment variable `GTK_IM_MODULE_FILE`
|
||||
* instead.
|
||||
*
|
||||
* * <literal>style <replaceable>name</replaceable> [ =
|
||||
* <replaceable>parent</replaceable> ] { ... }</literal>
|
||||
* * `style <replaceable>name</replaceable> [ =
|
||||
* <replaceable>parent</replaceable> ] { ... }`
|
||||
*
|
||||
* Declares a style.
|
||||
*
|
||||
* * <literal>widget <replaceable>pattern</replaceable>
|
||||
* * `widget <replaceable>pattern</replaceable>
|
||||
* [ style | binding ][ : <replaceable>priority</replaceable> ]
|
||||
* <replaceable>name</replaceable></literal>
|
||||
* <replaceable>name</replaceable>`
|
||||
*
|
||||
* Specifies a style or binding set for a particular
|
||||
* group of widgets by matching on the widget pathname.
|
||||
*
|
||||
* * <literal>widget_class <replaceable>pattern</replaceable>
|
||||
* * `widget_class <replaceable>pattern</replaceable>
|
||||
* [ style | binding ][ : <replaceable>priority</replaceable> ]
|
||||
* <replaceable>name</replaceable></literal>
|
||||
* <replaceable>name</replaceable>`
|
||||
*
|
||||
* Specifies a style or binding set for a particular
|
||||
* group of widgets by matching on the class pathname.
|
||||
@ -324,127 +324,127 @@
|
||||
*
|
||||
* # Styles #
|
||||
*
|
||||
* A RC style is specified by a <literal>style</literal>
|
||||
* A RC style is specified by a `style`
|
||||
* 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
|
||||
* with a `widget`, `widget_class`,
|
||||
* or `class` 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.
|
||||
* with `widget` declarations overriding
|
||||
* `widget_class` declarations which, in
|
||||
* turn, override `class` declarations.
|
||||
* Within each type of declaration, later declarations override
|
||||
* earlier ones.
|
||||
*
|
||||
* Within a <literal>style</literal> declaration, the possible
|
||||
* Within a `style` declaration, the possible
|
||||
* elements are:
|
||||
*
|
||||
* * <literal>bg[<replaceable>state</replaceable>] = <replaceable>color</replaceable></literal>
|
||||
* * `bg[<replaceable>state</replaceable>] = <replaceable>color</replaceable>`
|
||||
*
|
||||
* Sets the color used for the background of most widgets.
|
||||
*
|
||||
* * <literal>fg[<replaceable>state</replaceable>] = <replaceable>color</replaceable></literal>
|
||||
* * `fg[<replaceable>state</replaceable>] = <replaceable>color</replaceable>`
|
||||
*
|
||||
* Sets the color used for the foreground of most widgets.
|
||||
*
|
||||
* * <literal>base[<replaceable>state</replaceable>] = <replaceable>color</replaceable></literal>
|
||||
* * `base[<replaceable>state</replaceable>] = <replaceable>color</replaceable>`
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* * <literal>text[<replaceable>state</replaceable>] =
|
||||
* <replaceable>color</replaceable></literal>
|
||||
* * `text[<replaceable>state</replaceable>] =
|
||||
* <replaceable>color</replaceable>`
|
||||
*
|
||||
* Sets the color used for foreground of widgets using
|
||||
* <literal>base</literal> for the background color.
|
||||
* `base` for the background color.
|
||||
*
|
||||
* * <literal>xthickness =
|
||||
* <replaceable>number</replaceable></literal>
|
||||
* * `xthickness =
|
||||
* <replaceable>number</replaceable>`
|
||||
*
|
||||
* Sets the xthickness, which is used for various horizontal padding
|
||||
* values in GTK+.
|
||||
*
|
||||
* * <literal>ythickness =
|
||||
* <replaceable>number</replaceable></literal>
|
||||
* * `ythickness =
|
||||
* <replaceable>number</replaceable>`
|
||||
*
|
||||
* Sets the ythickness, which is used for various vertical padding
|
||||
* values in GTK+.
|
||||
*
|
||||
* * <literal>bg_pixmap[<replaceable>state</replaceable>] =
|
||||
* <replaceable>pixmap</replaceable></literal>
|
||||
* * `bg_pixmap[<replaceable>state</replaceable>] =
|
||||
* <replaceable>pixmap</replaceable>`
|
||||
*
|
||||
* 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
|
||||
* the `bg` color (or for #GtkText,
|
||||
* in place of the `base` color. The special
|
||||
* value `"<parent>"` 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.
|
||||
* `"<none>"` may be used to indicate no background pixmap.
|
||||
|
||||
* * <literal>font = <replaceable>font</replaceable></literal>
|
||||
* * `font = <replaceable>font</replaceable>`
|
||||
*
|
||||
* Starting with GTK+ 2.0, the "font" and "fontset"
|
||||
* declarations are ignored; use "font_name" declarations instead.
|
||||
*
|
||||
* * <literal>fontset = <replaceable>font</replaceable></literal>
|
||||
* * `fontset = <replaceable>font</replaceable>`
|
||||
*
|
||||
* Starting with GTK+ 2.0, the "font" and "fontset"
|
||||
* declarations are ignored; use "font_name" declarations instead.
|
||||
*
|
||||
* * <literal>font_name = <replaceable>font</replaceable></literal>
|
||||
* * `font_name = <replaceable>font</replaceable>`
|
||||
*
|
||||
* Sets the font for a widget. <replaceable>font</replaceable> must be
|
||||
* a Pango font name, e.g. <literal>"Sans Italic 10"</literal>.
|
||||
* a Pango font name, e.g. `"Sans Italic 10"`.
|
||||
* For details about Pango font names, see
|
||||
* pango_font_description_from_string().
|
||||
*
|
||||
* * <literal>stock[<replaceable>"stock-id"</replaceable>] = { <replaceable>icon source specifications</replaceable> }</literal>
|
||||
* * `stock[<replaceable>"stock-id"</replaceable>] = { <replaceable>icon source specifications</replaceable> }`
|
||||
*
|
||||
* Defines the icon for a stock item.
|
||||
*
|
||||
* * <literal>color[<replaceable>"color-name"</replaceable>] = <replaceable>color specification</replaceable></literal>
|
||||
* * `color[<replaceable>"color-name"</replaceable>] = <replaceable>color specification</replaceable>`
|
||||
*
|
||||
* Since 2.10, this element can be used to defines symbolic colors. See below for
|
||||
* the syntax of color specifications.
|
||||
*
|
||||
* * <literal>engine <replaceable>"engine"</replaceable> { <replaceable>engine-specific
|
||||
* settings</replaceable> }</literal>
|
||||
* * `engine <replaceable>"engine"</replaceable> { <replaceable>engine-specific
|
||||
* settings</replaceable> }`
|
||||
*
|
||||
* Defines the engine to be used when drawing with this style.
|
||||
*
|
||||
* * <literal><replaceable>class</replaceable>::<replaceable>property</replaceable> = <replaceable>value</replaceable></literal>
|
||||
* * `<replaceable>class</replaceable>::<replaceable>property</replaceable> = <replaceable>value</replaceable>`
|
||||
*
|
||||
* Sets a <link linkend="style-properties">style property</link> for a widget class.
|
||||
*
|
||||
* The colors and background pixmaps are specified as a function of the
|
||||
* state of the widget. The states are:
|
||||
*
|
||||
* * <literal>NORMAL</literal>
|
||||
* * `NORMAL`
|
||||
*
|
||||
* A color used for a widget in its normal state.
|
||||
*
|
||||
* * <literal>ACTIVE</literal>
|
||||
* * `ACTIVE`
|
||||
*
|
||||
* A variant of the <literal>NORMAL</literal> color used when the
|
||||
* A variant of the `NORMAL` 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.
|
||||
* of the `NORMAL` color.
|
||||
*
|
||||
* * <literal>PRELIGHT</literal>
|
||||
* * `PRELIGHT`
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* * <literal>SELECTED</literal>
|
||||
* * `SELECTED`
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* * <literal>INSENSITIVE</literal>
|
||||
* * `INSENSITIVE`
|
||||
*
|
||||
* A color used for the background of widgets that have
|
||||
* been set insensitive with gtk_widget_set_sensitive().
|
||||
@ -452,18 +452,18 @@
|
||||
* <anchor id="color-format"/>
|
||||
* Colors can be specified as a string containing a color name (GTK+ knows
|
||||
* all names from the X color database `/usr/lib/X11/rgb.txt`),
|
||||
* in one of the hexadecimal forms <literal>#rrrrggggbbbb</literal>,
|
||||
* <literal>#rrrgggbbb</literal>, <literal>#rrggbb</literal>,
|
||||
* or <literal>#rgb</literal>, where <literal>r</literal>,
|
||||
* <literal>g</literal> and <literal>b</literal> are
|
||||
* in one of the hexadecimal forms `#rrrrggggbbbb`,
|
||||
* `#rrrgggbbb`, `#rrggbb`,
|
||||
* or `#rgb`, where `r`,
|
||||
* `g` and `b` 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
|
||||
* `{ <replaceable>r</replaceable>, <replaceable>g</replaceable>,
|
||||
* <replaceable>b</replaceable>}`, where `r`,
|
||||
* `g` and `b` are either integers in
|
||||
* the range 0-65535 or floats in the range 0.0-1.0.
|
||||
*
|
||||
* Since 2.10, colors can also be specified by refering to a symbolic color, as
|
||||
* follows: <literal>@<!-- -->color-name</literal>, or by using expressions to combine
|
||||
* follows: `@<!-- -->color-name`, or by using expressions to combine
|
||||
* colors. The following expressions are currently supported:
|
||||
*
|
||||
* * mix (<replaceable>factor</replaceable>, <replaceable>color1</replaceable>, <replaceable>color2</replaceable>)
|
||||
@ -483,12 +483,12 @@
|
||||
* * lighter (<replaceable>color</replaceable>)
|
||||
*
|
||||
* This is an abbreviation for
|
||||
* <literal>shade (1.3, <replaceable>color</replaceable>)</literal>.
|
||||
* `shade (1.3, <replaceable>color</replaceable>)`.
|
||||
*
|
||||
* * darker (<replaceable>color</replaceable>)
|
||||
*
|
||||
* This is an abbreviation for
|
||||
* <literal>shade (0.7, <replaceable>color</replaceable>)</literal>.
|
||||
* `shade (0.7, <replaceable>color</replaceable>)`.
|
||||
*
|
||||
* Here are some examples of color expressions:
|
||||
*
|
||||
@ -498,16 +498,16 @@
|
||||
* lighter (@<!-- -->foreground)
|
||||
* ]|
|
||||
*
|
||||
* In a <literal>stock</literal> definition, icon sources are specified as a
|
||||
* In a `stock` definition, icon sources are specified as a
|
||||
* 4-tuple of image filename or icon name, text direction, widget state, and size, in that
|
||||
* order. Each icon source specifies an image filename or icon name to use with a given
|
||||
* direction, state, and size. Filenames are specified as a string such
|
||||
* as <literal>"itemltr.png"</literal>, while icon names (looked up
|
||||
* as `"itemltr.png"`, while icon names (looked up
|
||||
* in the current icon theme), are specified with a leading
|
||||
* <literal>@</literal>, such as <literal>@"item-ltr"</literal>.
|
||||
* The <literal>*</literal> character can be used as a
|
||||
* `@`, such as `@"item-ltr"`.
|
||||
* The `*` 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
|
||||
* `*`. So for example, the following specifies different icons to
|
||||
* use for left-to-right and right-to-left languages:
|
||||
*
|
||||
* |[<!-- language="C" -->
|
||||
@ -539,9 +539,9 @@
|
||||
* }
|
||||
* ]|
|
||||
*
|
||||
* 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
|
||||
* The sizes that come with GTK+ itself are `"gtk-menu"`,
|
||||
* `"gtk-small-toolbar"`, `"gtk-large-toolbar"`,
|
||||
* `"gtk-button"`, `"gtk-dialog"`. Applications
|
||||
* can define other sizes.
|
||||
*
|
||||
* It's also possible to use custom icons for a given state, for example:
|
||||
@ -558,7 +558,7 @@
|
||||
* 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;
|
||||
* `PRELIGHT` 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.
|
||||
*
|
||||
@ -582,41 +582,41 @@
|
||||
* series of modifiers followed by the name of a key. The
|
||||
* modifiers can be:
|
||||
*
|
||||
* - <literal><alt></literal>
|
||||
* - `<alt>`
|
||||
*
|
||||
* - <literal><ctl></literal>
|
||||
* - `<ctl>`
|
||||
*
|
||||
* - <literal><control></literal>
|
||||
* - `<control>`
|
||||
*
|
||||
* - <literal><meta></literal>
|
||||
* - `<meta>`
|
||||
*
|
||||
* - <literal><hyper></literal>
|
||||
* - `<hyper>`
|
||||
*
|
||||
* - <literal><super></literal>
|
||||
* - `<super>`
|
||||
*
|
||||
* - <literal><mod1></literal>
|
||||
* - `<mod1>`
|
||||
*
|
||||
* - <literal><mod2></literal>
|
||||
* - `<mod2>`
|
||||
*
|
||||
* - <literal><mod3></literal>
|
||||
* - `<mod3>`
|
||||
*
|
||||
* - <literal><mod4></literal>
|
||||
* - `<mod4>`
|
||||
*
|
||||
* - <literal><mod5></literal>
|
||||
* - `<mod5>`
|
||||
*
|
||||
* - <literal><release></literal>
|
||||
* - `<release>`
|
||||
*
|
||||
* - <literal><shft></literal>
|
||||
* - `<shft>`
|
||||
*
|
||||
* - <literal><shift></literal>
|
||||
* - `<shift>`
|
||||
*
|
||||
* <literal><shft></literal> is an alias for
|
||||
* <literal><shift></literal>,
|
||||
* <literal><ctl></literal> is an alias for
|
||||
* <literal><control></literal>,
|
||||
* `<shft>` is an alias for
|
||||
* `<shift>`,
|
||||
* `<ctl>` is an alias for
|
||||
* `<control>`,
|
||||
* and
|
||||
* <literal><alt></literal> is an alias for
|
||||
* <literal><mod1></literal>.
|
||||
* `<alt>` is an alias for
|
||||
* `<mod1>`.
|
||||
*
|
||||
* The action that is bound to the key is a sequence
|
||||
* of signal names (strings) followed by parameters for
|
||||
|
@ -918,7 +918,7 @@ gtk_style_has_context (GtkStyle *style)
|
||||
*
|
||||
* Since this function may return a new object, you have to use it
|
||||
* in the following way:
|
||||
* <literal>style = gtk_style_attach (style, window)</literal>
|
||||
* `style = gtk_style_attach (style, window)`
|
||||
*
|
||||
* Returns: Either @style, or a newly-created #GtkStyle.
|
||||
* If the style is newly created, the style parameter
|
||||
|
@ -805,7 +805,7 @@ gtk_table_attach (GtkTable *table,
|
||||
* As there are many options associated with gtk_table_attach(), this convenience
|
||||
* function provides the programmer with a means to add children to a table with
|
||||
* identical padding and expansion options. The values used for the #GtkAttachOptions
|
||||
* are <literal>GTK_EXPAND | GTK_FILL</literal>, and the padding is set to 0.
|
||||
* are `GTK_EXPAND | GTK_FILL`, and the padding is set to 0.
|
||||
*
|
||||
* Deprecated: 3.4: Use gtk_grid_attach() with #GtkGrid. Note that the attach
|
||||
* arguments differ between those two functions.
|
||||
|
@ -206,9 +206,9 @@
|
||||
* Merging is done based on the names of the XML elements. Each element is
|
||||
* identified by a path which consists of the names of its anchestors, separated
|
||||
* by slashes. For example, the menuitem named "Left" in the example above
|
||||
* has the path <literal>/ui/menubar/JustifyMenu/Left</literal> and the
|
||||
* has the path `/ui/menubar/JustifyMenu/Left` and the
|
||||
* toolitem with the same name has path
|
||||
* <literal>/ui/toolbar1/JustifyToolItems/Left</literal>.
|
||||
* `/ui/toolbar1/JustifyToolItems/Left`.
|
||||
*
|
||||
* # Accelerators #
|
||||
*
|
||||
@ -227,7 +227,7 @@
|
||||
* can make it hard or impossible to determine in advance whether a separator
|
||||
* will end up in such an unfortunate position.
|
||||
*
|
||||
* For separators in toolbars, you can set <literal>expand="true"</literal> to
|
||||
* For separators in toolbars, you can set `expand="true"` to
|
||||
* turn them from a small, visible separator to an expanding, invisible one.
|
||||
* Toolitems following an expanding separator are effectively right-aligned.
|
||||
*
|
||||
|
@ -67,8 +67,8 @@
|
||||
* a program like its logo, name, copyright, website and license. It is
|
||||
* also possible to give credits to the authors, documenters, translators
|
||||
* and artists who have worked on the program. An about dialog is typically
|
||||
* opened when the user selects the <literal>About</literal> option from
|
||||
* the <literal>Help</literal> menu. All parts of the dialog are optional.
|
||||
* opened when the user selects the `About` option from
|
||||
* the `Help` menu. All parts of the dialog are optional.
|
||||
*
|
||||
* About dialogs often contain links and email addresses. GtkAboutDialog
|
||||
* displays these as clickable links. By default, it calls gtk_show_uri()
|
||||
@ -79,7 +79,7 @@
|
||||
* use the function gtk_show_about_dialog() which constructs and shows a dialog
|
||||
* and keeps it around so that it can be shown again.
|
||||
*
|
||||
* Note that GTK+ sets a default title of <literal>_("About %s")</literal>
|
||||
* Note that GTK+ sets a default title of `_("About %s")`
|
||||
* on the dialog window (where %s is replaced by the name of the
|
||||
* application, but in order to ensure proper translation of the title,
|
||||
* applications should set the title property explicitly when constructing
|
||||
|
@ -228,8 +228,8 @@ gtk_actionable_set_action_target (GtkActionable *actionable,
|
||||
* the target is string-valued.
|
||||
*
|
||||
* @detailed_action_name is a string of the form
|
||||
* <literal>"action::target"</literal> where <literal>action</literal>
|
||||
* is the action name and <literal>target</literal> is the string to use
|
||||
* `"action::target"` where `action`
|
||||
* is the action name and `target` is the string to use
|
||||
* as the target.
|
||||
*
|
||||
* Since: 3.4
|
||||
|
@ -651,11 +651,11 @@ gtk_action_muxer_class_init (GObjectClass *class)
|
||||
* Adds the actions in @action_group to the list of actions provided by
|
||||
* @muxer. @prefix is prefixed to each action name, such that for each
|
||||
* action <varname>x</varname> in @action_group, there is an equivalent
|
||||
* action @prefix<literal>.</literal><varname>x</varname> in @muxer.
|
||||
* action @prefix`.`<varname>x</varname> in @muxer.
|
||||
*
|
||||
* For example, if @prefix is "<literal>app</literal>" and @action_group
|
||||
* contains an action called "<literal>quit</literal>", then @muxer will
|
||||
* now contain an action called "<literal>app.quit</literal>".
|
||||
* For example, if @prefix is "`app`" and @action_group
|
||||
* contains an action called "`quit`", then @muxer will
|
||||
* now contain an action called "`app.quit`".
|
||||
*
|
||||
* If any #GtkActionObservers are registered for actions in the group,
|
||||
* "action_added" notifications will be emitted, as appropriate.
|
||||
|
@ -147,7 +147,7 @@ gtk_adjustment_class_init (GtkAdjustmentClass *class)
|
||||
*
|
||||
* The maximum value of the adjustment.
|
||||
* Note that values will be restricted by
|
||||
* <literal>upper - page-size</literal> if the page-size
|
||||
* `upper - page-size` if the page-size
|
||||
* property is nonzero.
|
||||
*
|
||||
* Since: 2.4
|
||||
@ -515,7 +515,7 @@ gtk_adjustment_get_upper (GtkAdjustment *adjustment)
|
||||
* Sets the maximum value of the adjustment.
|
||||
*
|
||||
* Note that values will be restricted by
|
||||
* <literal>upper - page-size</literal> if the page-size
|
||||
* `upper - page-size` if the page-size
|
||||
* property is nonzero.
|
||||
*
|
||||
* See gtk_adjustment_set_lower() about how to compress multiple
|
||||
|
@ -121,7 +121,7 @@
|
||||
*
|
||||
* Attribute values can be translated using gettext, like other #GtkBuilder
|
||||
* content. `<attribute>` elements can be marked for
|
||||
* translation with a <literal>translatable="yes"</literal> attribute.
|
||||
* translation with a `translatable="yes"` attribute.
|
||||
* It is also possible to specify message context and translator comments,
|
||||
* using the context and comments attributes. To make use of this, the
|
||||
* #GtkBuilder must have been given the gettext domain to use.
|
||||
@ -909,9 +909,9 @@ gtk_application_window_set_show_menubar (GtkApplicationWindow *window,
|
||||
* @window: a #GtkApplicationWindow
|
||||
*
|
||||
* Returns the unique ID of the window. If the window has not yet been added to
|
||||
* a #GtkApplication, returns <literal>0</literal>.
|
||||
* a #GtkApplication, returns `0`.
|
||||
*
|
||||
* Returns: the unique ID for @window, or <literal>0</literal> if the window
|
||||
* Returns: the unique ID for @window, or `0` if the window
|
||||
* has not yet been added to a #GtkApplication
|
||||
*
|
||||
* Since: 3.6
|
||||
|
@ -328,8 +328,8 @@ clipboard_display_closed (GdkDisplay *display,
|
||||
* to the default clipboard, i.e. they copy the selection to what the
|
||||
* user sees as the clipboard.
|
||||
*
|
||||
* (Passing #GDK_NONE is the same as using <literal>gdk_atom_intern
|
||||
* ("CLIPBOARD", FALSE)</literal>. See <ulink
|
||||
* (Passing #GDK_NONE is the same as using `gdk_atom_intern
|
||||
* ("CLIPBOARD", FALSE)`. See <ulink
|
||||
* url="http://www.freedesktop.org/Standards/clipboards-spec">
|
||||
* http://www.freedesktop.org/Standards/clipboards-spec</ulink>
|
||||
* for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY"
|
||||
|
@ -803,8 +803,8 @@ gtk_combo_box_class_init (GtkComboBoxClass *klass)
|
||||
* The item which is currently active. If the model is a non-flat treemodel,
|
||||
* and the active item is not an immediate child of the root of the tree,
|
||||
* this property has the value
|
||||
* <literal>gtk_tree_path_get_indices (path)[0]</literal>,
|
||||
* where <literal>path</literal> is the #GtkTreePath of the active item.
|
||||
* `gtk_tree_path_get_indices (path)[0]`,
|
||||
* where `path` is the #GtkTreePath of the active item.
|
||||
*
|
||||
* Since: 2.4
|
||||
*/
|
||||
@ -4258,8 +4258,8 @@ gtk_combo_box_set_column_span_column (GtkComboBox *combo_box,
|
||||
* Returns the index of the currently active item, or -1 if there's no
|
||||
* active item. If the model is a non-flat treemodel, and the active item
|
||||
* is not an immediate child of the root of the tree, this function returns
|
||||
* <literal>gtk_tree_path_get_indices (path)[0]</literal>, where
|
||||
* <literal>path</literal> is the #GtkTreePath of the active item.
|
||||
* `gtk_tree_path_get_indices (path)[0]`, where
|
||||
* `path` is the #GtkTreePath of the active item.
|
||||
*
|
||||
* Return value: An integer which is the index of the currently active item,
|
||||
* or -1 if there's no active item.
|
||||
|
@ -103,16 +103,16 @@
|
||||
* various ways:
|
||||
* - To require that a widget satisfies several conditions,
|
||||
* combine several selectors into one by concatenating them. E.g.
|
||||
* <literal>GtkButton#button1</literal> matches a GtkButton widget
|
||||
* `GtkButton#button1` matches a GtkButton widget
|
||||
* with the name button1.
|
||||
* - To only match a widget when it occurs inside some other
|
||||
* widget, write the two selectors after each other, separated by whitespace.
|
||||
* E.g. <literal>GtkToolBar GtkButton</literal> matches GtkButton widgets
|
||||
* E.g. `GtkToolBar GtkButton` matches GtkButton widgets
|
||||
* that occur inside a GtkToolBar.
|
||||
* - In the previous example, the GtkButton is matched even
|
||||
* if it occurs deeply nested inside the toolbar. To restrict the match
|
||||
* to direct children of the parent widget, insert a '>' character between
|
||||
* the two selectors. E.g. <literal>GtkNotebook > GtkLabel</literal> matches
|
||||
* the two selectors. E.g. `GtkNotebook > GtkLabel` matches
|
||||
* GtkLabel widgets that are direct children of a GtkNotebook.
|
||||
*
|
||||
* An example of widget classes and names in selectors:
|
||||
|
@ -1044,7 +1044,7 @@ gtk_dialog_add_buttons (GtkDialog *dialog,
|
||||
* @response_id: a response ID
|
||||
* @setting: %TRUE for sensitive
|
||||
*
|
||||
* Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
|
||||
* Calls `gtk_widget_set_sensitive (widget, @setting)`
|
||||
* for each widget in the dialog's action area with the given @response_id.
|
||||
* A convenient way to sensitize/desensitize dialog buttons.
|
||||
**/
|
||||
|
@ -54,7 +54,7 @@ typedef struct _GtkEntryCompletionPrivate GtkEntryCompletionPrivate;
|
||||
* Note that @key is normalized and case-folded (see g_utf8_normalize()
|
||||
* and g_utf8_casefold()). If this is not appropriate, match functions
|
||||
* have access to the unmodified key via
|
||||
* <literal>gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry (<!-- -->)))</literal>.
|
||||
* `gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry (<!-- -->)))`.
|
||||
*
|
||||
* Returns: %TRUE if @iter should be displayed as a possible completion
|
||||
* for @key
|
||||
|
@ -7178,7 +7178,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
|
||||
* <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
|
||||
* with a @path string of "" (the empty
|
||||
* string). It is also bound to <keycap>/</keycap> with a
|
||||
* @path string of "<literal>/</literal>"
|
||||
* @path string of "`/`"
|
||||
* (a slash): this lets you type <keycap>/</keycap> and
|
||||
* immediately type a path name. On Unix systems, this is bound to
|
||||
* <keycap>~</keycap> (tilde) with a <parameter>path</parameter> string
|
||||
|
@ -73,7 +73,7 @@
|
||||
* follows the <ulink
|
||||
* url="http://www.freedesktop.org/Standards/icon-theme-spec">Icon
|
||||
* Theme Specification</ulink>. There is a default icon theme,
|
||||
* named <literal>hicolor</literal> where applications should install
|
||||
* named `hicolor` where applications should install
|
||||
* their icons, but more additional application themes can be
|
||||
* installed as operating system vendors and users choose.
|
||||
*
|
||||
|
@ -2187,8 +2187,8 @@ gtk_icon_view_remove_editable (GtkCellArea *area,
|
||||
* it. Additionally, if @start_editing is %TRUE, then editing should be
|
||||
* started in the specified cell.
|
||||
*
|
||||
* This function is often followed by <literal>gtk_widget_grab_focus
|
||||
* (icon_view)</literal> in order to give keyboard focus to the widget.
|
||||
* This function is often followed by `gtk_widget_grab_focus
|
||||
* (icon_view)` in order to give keyboard focus to the widget.
|
||||
* Please note that editing can only happen when the widget is realized.
|
||||
*
|
||||
* Since: 2.8
|
||||
|
@ -95,7 +95,7 @@
|
||||
* Labels may contain “mnemonics”. Mnemonics are
|
||||
* underlined characters in the label, used for keyboard navigation.
|
||||
* Mnemonics are created by providing a string with an underscore before
|
||||
* the mnemonic character, such as <literal>"_File"</literal>, to the
|
||||
* the mnemonic character, such as `"_File"`, to the
|
||||
* functions gtk_label_new_with_mnemonic() or
|
||||
* gtk_label_set_text_with_mnemonic().
|
||||
*
|
||||
|
@ -1367,7 +1367,7 @@ gtk_level_bar_remove_offset_value (GtkLevelBar *self,
|
||||
* Adds a new offset marker on @self at the position specified by @value.
|
||||
* When the bar value is in the interval topped by @value (or between @value
|
||||
* and #GtkLevelBar:max-value in case the offset is the last one on the bar)
|
||||
* a style class named <literal>level-</literal>@name will be applied
|
||||
* a style class named `level-`@name will be applied
|
||||
* when rendering the level bar fill.
|
||||
* If another offset marker named @name exists, its value will be
|
||||
* replaced by @value.
|
||||
|
@ -409,8 +409,8 @@ iter_is_valid (GtkTreeIter *iter,
|
||||
* in. Note that only types derived from standard GObject fundamental types
|
||||
* are supported.
|
||||
*
|
||||
* As an example, <literal>gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING,
|
||||
* GDK_TYPE_PIXBUF);</literal> will create a new #GtkListStore with three columns, of type
|
||||
* As an example, `gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING,
|
||||
* GDK_TYPE_PIXBUF);` will create a new #GtkListStore with three columns, of type
|
||||
* int, string and #GdkPixbuf respectively.
|
||||
*
|
||||
* Return value: a new #GtkListStore
|
||||
@ -1166,8 +1166,8 @@ gtk_list_store_set_valist (GtkListStore *list_store,
|
||||
* The variable argument list should contain integer column numbers,
|
||||
* each column number followed by the value to be set.
|
||||
* The list is terminated by a -1. For example, to set column 0 with type
|
||||
* %G_TYPE_STRING to "Foo", you would write <literal>gtk_list_store_set (store, iter,
|
||||
* 0, "Foo", -1)</literal>.
|
||||
* %G_TYPE_STRING to "Foo", you would write `gtk_list_store_set (store, iter,
|
||||
* 0, "Foo", -1)`.
|
||||
*
|
||||
* The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
|
||||
* will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
|
||||
@ -1679,7 +1679,7 @@ gtk_list_store_reorder_func (GSequenceIter *a,
|
||||
* @store: A #GtkListStore.
|
||||
* @new_order: (array zero-terminated=1): an array of integers mapping the new
|
||||
* position of each child to its old position before the re-ordering,
|
||||
* i.e. @new_order<literal>[newpos] = oldpos</literal>. It must have
|
||||
* i.e. @new_order`[newpos] = oldpos`. It must have
|
||||
* exactly as many items as the list store's length.
|
||||
*
|
||||
* Reorders @store to follow the order indicated by @new_order. Note that
|
||||
@ -2165,7 +2165,7 @@ gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable)
|
||||
* values given to this function.
|
||||
*
|
||||
* Calling
|
||||
* <literal>gtk_list_store_insert_with_values (list_store, iter, position...)</literal>
|
||||
* `gtk_list_store_insert_with_values (list_store, iter, position...)`
|
||||
* has the same effect as calling
|
||||
* |[<!-- language="C" -->
|
||||
* gtk_list_store_insert (list_store, iter, position);
|
||||
|
@ -381,7 +381,7 @@ static gboolean do_setlocale = TRUE;
|
||||
*
|
||||
* Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and
|
||||
* gtk_parse_args() from automatically
|
||||
* calling <literal>setlocale (LC_ALL, "")</literal>. You would
|
||||
* calling `setlocale (LC_ALL, "")`. You would
|
||||
* want to use this function if you wanted to set the locale for
|
||||
* your program to something other than the user's locale, or if
|
||||
* you wanted to set different values for different locale categories.
|
||||
@ -841,7 +841,7 @@ gtk_get_option_group (gboolean open_default_display)
|
||||
* understood by GTK+ are stripped before return.
|
||||
* @parameter_string: (allow-none): a string which is displayed in
|
||||
* the first line of `--help` output, after
|
||||
* <literal><replaceable>programname</replaceable> [OPTION...]</literal>
|
||||
* `<replaceable>programname</replaceable> [OPTION...]`
|
||||
* @entries: (array zero-terminated=1): a %NULL-terminated array
|
||||
* of #GOptionEntrys describing the options of your program
|
||||
* @translation_domain: a translation domain to use for translating
|
||||
@ -1015,7 +1015,7 @@ gtk_init_check (int *argc,
|
||||
* your program to fall back to a textual interface you want to
|
||||
* call gtk_init_check() instead.
|
||||
*
|
||||
* Since 2.18, GTK+ calls <literal>signal (SIGPIPE, SIG_IGN)</literal>
|
||||
* Since 2.18, GTK+ calls `signal (SIGPIPE, SIG_IGN)`
|
||||
* during initialization, to ignore SIGPIPE signals, since these are
|
||||
* almost never wanted in graphical applications. If you do need to
|
||||
* handle SIGPIPE for some reason, reset the handler after gtk_init(),
|
||||
|
@ -2035,9 +2035,9 @@ gtk_menu_real_can_activate_accel (GtkWidget *widget,
|
||||
* purpose, automatically gets an accel path assigned.
|
||||
*
|
||||
* For example, a menu containing menu items "New" and "Exit", will, after
|
||||
* <literal>gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");</literal>
|
||||
* `gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");`
|
||||
* has been called, assign its items the accel paths:
|
||||
* <literal>"<Gnumeric-Sheet>/File/New"</literal> and <literal>"<Gnumeric-Sheet>/File/Exit"</literal>.
|
||||
* `"<Gnumeric-Sheet>/File/New"` and `"<Gnumeric-Sheet>/File/Exit"`.
|
||||
*
|
||||
* Assigning accel paths to menu items then enables the user to change
|
||||
* their accelerators at runtime. More details about accelerator paths
|
||||
|
@ -1896,7 +1896,7 @@ gtk_paned_new (GtkOrientation orientation)
|
||||
*
|
||||
* Adds a child to the top or left pane with default parameters. This is
|
||||
* equivalent to
|
||||
* <literal>gtk_paned_pack1 (paned, child, FALSE, TRUE)</literal>.
|
||||
* `gtk_paned_pack1 (paned, child, FALSE, TRUE)`.
|
||||
*/
|
||||
void
|
||||
gtk_paned_add1 (GtkPaned *paned,
|
||||
@ -1912,7 +1912,7 @@ gtk_paned_add1 (GtkPaned *paned,
|
||||
*
|
||||
* Adds a child to the bottom or right pane with default parameters. This
|
||||
* is equivalent to
|
||||
* <literal>gtk_paned_pack2 (paned, child, TRUE, TRUE)</literal>.
|
||||
* `gtk_paned_pack2 (paned, child, TRUE, TRUE)`.
|
||||
*/
|
||||
void
|
||||
gtk_paned_add2 (GtkPaned *paned,
|
||||
|
@ -71,7 +71,7 @@ _gtk_get_data_prefix (void)
|
||||
*
|
||||
* Return the Unix-style locale string for the language currently in
|
||||
* effect. On Unix systems, this is the return value from
|
||||
* <literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
|
||||
* `setlocale(LC_CTYPE, NULL)`, and the user can
|
||||
* affect this through the environment variables LC_ALL, LC_CTYPE or
|
||||
* LANG (checked in that order). The locale strings typically is in
|
||||
* the form lang_COUNTRY, where lang is an ISO-639 language code, and
|
||||
|
@ -976,8 +976,8 @@ gtk_settings_class_init (GtkSettingsClass *class)
|
||||
* GtkSettings:gtk-print-preview-command:
|
||||
*
|
||||
* A command to run for displaying the print preview. The command
|
||||
* should contain a <literal>%f</literal> placeholder, which will get replaced by
|
||||
* the path to the pdf file. The command may also contain a <literal>%s</literal>
|
||||
* should contain a `%f` placeholder, which will get replaced by
|
||||
* the path to the pdf file. The command may also contain a `%s`
|
||||
* placeholder, which will get replaced by the path to a file
|
||||
* containing the print settings in the format produced by
|
||||
* gtk_print_settings_to_file().
|
||||
@ -2336,7 +2336,7 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS
|
||||
* A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
|
||||
* or gtk_widget_class_install_style_property_parser() which parses a
|
||||
* color given either by its name or in the form
|
||||
* <literal>{ red, green, blue }</literal> where red, green and
|
||||
* `{ red, green, blue }` where red, green and
|
||||
* blue are integers between 0 and 65535 or floating-point numbers
|
||||
* between 0 and 1.
|
||||
*
|
||||
@ -2477,7 +2477,7 @@ parse_flags_value (GScanner *scanner,
|
||||
*
|
||||
* Flags can be specified by their name, their nickname or
|
||||
* numerically. Multiple flags can be specified in the form
|
||||
* <literal>"( flag1 | flag2 | ... )"</literal>.
|
||||
* `"( flag1 | flag2 | ... )"`.
|
||||
*
|
||||
* Return value: %TRUE if @gstring could be parsed and @property_value
|
||||
* has been set to the resulting flags value.
|
||||
@ -2581,7 +2581,7 @@ get_braced_int (GScanner *scanner,
|
||||
* A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
|
||||
* or gtk_widget_class_install_style_property_parser() which parses a
|
||||
* requisition in the form
|
||||
* <literal>"{ width, height }"</literal> for integers %width and %height.
|
||||
* `"{ width, height }"` for integers %width and %height.
|
||||
*
|
||||
* Return value: %TRUE if @gstring could be parsed and @property_value
|
||||
* has been set to the resulting #GtkRequisition.
|
||||
@ -2622,7 +2622,7 @@ gtk_rc_property_parse_requisition (const GParamSpec *pspec,
|
||||
* A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
|
||||
* or gtk_widget_class_install_style_property_parser() which parses
|
||||
* borders in the form
|
||||
* <literal>"{ left, right, top, bottom }"</literal> for integers
|
||||
* `"{ left, right, top, bottom }"` for integers
|
||||
* left, right, top and bottom.
|
||||
*
|
||||
* Return value: %TRUE if @gstring could be parsed and @property_value
|
||||
|
@ -85,7 +85,7 @@
|
||||
* ## GtkSizeGroup as GtkBuildable
|
||||
*
|
||||
* Size groups can be specified in a UI definition by placing an
|
||||
* <object> element with <literal>class="GtkSizeGroup"</literal>
|
||||
* <object> element with `class="GtkSizeGroup"`
|
||||
* somewhere in the UI definition. The widgets that belong to the
|
||||
* size group are specified by a <widgets> element that may
|
||||
* contain multiple <widget> elements, one for each member
|
||||
|
@ -304,7 +304,7 @@ gtk_socket_new (void)
|
||||
* client may be in the same process or in a different process.
|
||||
*
|
||||
* To embed a #GtkPlug in a #GtkSocket, you can either create the
|
||||
* #GtkPlug with <literal>gtk_plug_new (0)</literal>, call
|
||||
* #GtkPlug with `gtk_plug_new (0)`, call
|
||||
* gtk_plug_get_id() to get the window ID of the plug, and then pass that to the
|
||||
* gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the
|
||||
* window ID for the socket, and call gtk_plug_new() passing in that
|
||||
|
@ -53,7 +53,7 @@ G_BEGIN_DECLS
|
||||
* lists returned by gtk_text_buffer_get_copy_target_list() and
|
||||
* gtk_text_buffer_get_paste_target_list().
|
||||
*
|
||||
* The values counts down from <literal>-1</literal> to avoid clashes
|
||||
* The values counts down from `-1` to avoid clashes
|
||||
* with application added drag destinations which usually start at 0.
|
||||
*/
|
||||
typedef enum
|
||||
|
@ -406,7 +406,7 @@ gtk_text_iter_get_buffer (const GtkTextIter *iter)
|
||||
*
|
||||
* Creates a dynamically-allocated copy of an iterator. This function
|
||||
* is not useful in applications, because iterators can be copied with a
|
||||
* simple assignment (<literal>GtkTextIter i = j;</literal>). The
|
||||
* simple assignment (`GtkTextIter i = j;`). The
|
||||
* function is used by language bindings.
|
||||
*
|
||||
* Return value: a copy of the @iter, free with gtk_text_iter_free ()
|
||||
@ -449,7 +449,7 @@ gtk_text_iter_free (GtkTextIter *iter)
|
||||
*
|
||||
* Assigns the value of @other to @iter. This function
|
||||
* is not useful in applications, because iterators can be assigned
|
||||
* with <literal>GtkTextIter i = j;</literal>. The
|
||||
* with `GtkTextIter i = j;`. The
|
||||
* function is used by language bindings.
|
||||
*
|
||||
* Since: 3.2
|
||||
|
@ -9502,7 +9502,7 @@ gtk_text_view_get_window (GtkTextView *text_view,
|
||||
*
|
||||
* Usually used to find out which window an event corresponds to.
|
||||
* If you connect to an event signal on @text_view, this function
|
||||
* should be called on <literal>event->window</literal> to
|
||||
* should be called on `event->window` to
|
||||
* see which window it was.
|
||||
*
|
||||
* Return value: the window type.
|
||||
|
@ -450,7 +450,7 @@ gtk_tree_model_base_init (gpointer g_class)
|
||||
* have been reordered, or %NULL if the depth of @path is 0
|
||||
* @new_order: an array of integers mapping the current position
|
||||
* of each child to its old position before the re-ordering,
|
||||
* i.e. @new_order<literal>[newpos] = oldpos</literal>
|
||||
* i.e. @new_order`[newpos] = oldpos`
|
||||
*
|
||||
* This signal is emitted when the children of a node in the
|
||||
* #GtkTreeModel have been reordered.
|
||||
@ -1122,7 +1122,7 @@ gtk_tree_path_down (GtkTreePath *path)
|
||||
*
|
||||
* This function is not intended for use in applications,
|
||||
* because you can just copy the structs by value
|
||||
* (<literal>GtkTreeIter new_iter = iter;</literal>).
|
||||
* (`GtkTreeIter new_iter = iter;`).
|
||||
* You must free this iter with gtk_tree_iter_free().
|
||||
*
|
||||
* Return value: a newly-allocated copy of @iter
|
||||
@ -1509,7 +1509,7 @@ gtk_tree_model_iter_previous (GtkTreeModel *tree_model,
|
||||
* function has been called.
|
||||
*
|
||||
* If @parent is %NULL returns the first node, equivalent to
|
||||
* <literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
|
||||
* `gtk_tree_model_get_iter_first (tree_model, iter);`
|
||||
*
|
||||
* Return value: %TRUE, if @child has been set to the first child
|
||||
*/
|
||||
@ -1728,8 +1728,8 @@ gtk_tree_model_unref_node (GtkTreeModel *tree_model,
|
||||
* each column number followed by a place to store the value being
|
||||
* retrieved. The list is terminated by a -1. For example, to get a
|
||||
* value from column 0 with type %G_TYPE_STRING, you would
|
||||
* write: <literal>gtk_tree_model_get (model, iter, 0, &place_string_here, -1)</literal>,
|
||||
* where <literal>place_string_here</literal> is a #gchararray
|
||||
* write: `gtk_tree_model_get (model, iter, 0, &place_string_here, -1)`,
|
||||
* where `place_string_here` is a #gchararray
|
||||
* to be filled with the string.
|
||||
*
|
||||
* Returned values with type %G_TYPE_OBJECT have to be unreferenced,
|
||||
@ -1899,7 +1899,7 @@ gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
|
||||
* have been reordered, or %NULL if the depth of @path is 0
|
||||
* @new_order: an array of integers mapping the current position of
|
||||
* each child to its old position before the re-ordering,
|
||||
* i.e. @new_order<literal>[newpos] = oldpos</literal>
|
||||
* i.e. @new_order`[newpos] = oldpos`
|
||||
*
|
||||
* Emits the #GtkTreeModel::rows-reordered signal on @tree_model.
|
||||
*
|
||||
@ -1929,7 +1929,7 @@ gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
|
||||
* @new_order: (array length=length): an array of integers
|
||||
* mapping the current position of each child to its old
|
||||
* position before the re-ordering,
|
||||
* i.e. @new_order<literal>[newpos] = oldpos</literal>
|
||||
* i.e. @new_order`[newpos] = oldpos`
|
||||
* @length: length of @new_order array
|
||||
*
|
||||
* Emits the #GtkTreeModel::rows-reordered signal on @tree_model.
|
||||
|
@ -75,7 +75,7 @@ typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
|
||||
*
|
||||
* For example, if @model is a product catalogue, then a compare function
|
||||
* for the "price" column could be one which returns
|
||||
* <literal>price_of(@a) - price_of(@b)</literal>.
|
||||
* `price_of(@a) - price_of(@b)`.
|
||||
*
|
||||
* Returns: a negative integer, zero or a positive integer depending on whether
|
||||
* @a sorts before, with or after @b
|
||||
|
@ -304,8 +304,8 @@ gtk_tree_store_init (GtkTreeStore *tree_store)
|
||||
* in. Note that only types derived from standard GObject fundamental types
|
||||
* are supported.
|
||||
*
|
||||
* As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
|
||||
* GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
|
||||
* As an example, `gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
|
||||
* GDK_TYPE_PIXBUF);` will create a new #GtkTreeStore with three columns, of type
|
||||
* #gint, #gchararray, and #GdkPixbuf respectively.
|
||||
*
|
||||
* Return value: a new #GtkTreeStore
|
||||
@ -1170,7 +1170,7 @@ gtk_tree_store_set_valist (GtkTreeStore *tree_store,
|
||||
* each column number followed by the value to be set.
|
||||
* The list is terminated by a -1. For example, to set column 0 with type
|
||||
* %G_TYPE_STRING to "Foo", you would write
|
||||
* <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
|
||||
* `gtk_tree_store_set (store, iter, 0, "Foo", -1)`.
|
||||
*
|
||||
* The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
|
||||
* will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
|
||||
@ -1494,7 +1494,7 @@ gtk_tree_store_insert_after (GtkTreeStore *tree_store,
|
||||
* the values given to this function.
|
||||
*
|
||||
* Calling
|
||||
* <literal>gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</literal>
|
||||
* `gtk_tree_store_insert_with_values (tree_store, iter, position, ...)`
|
||||
* has the same effect as calling
|
||||
* |[<!-- language="C" -->
|
||||
* gtk_tree_store_insert (tree_store, iter, position);
|
||||
@ -2252,7 +2252,7 @@ gtk_tree_store_reorder_func (gconstpointer a,
|
||||
* @parent: A #GtkTreeIter.
|
||||
* @new_order: (array): an array of integers mapping the new position of each child
|
||||
* to its old position before the re-ordering,
|
||||
* i.e. @new_order<literal>[newpos] = oldpos</literal>.
|
||||
* i.e. @new_order`[newpos] = oldpos`.
|
||||
*
|
||||
* Reorders the children of @parent in @tree_store to follow the order
|
||||
* indicated by @new_order. Note that this function only works with
|
||||
|
@ -81,7 +81,7 @@
|
||||
*
|
||||
* Coordinate systems in GtkTreeView API:
|
||||
*
|
||||
* - Widget coordinates: Coordinates relative to the widget (usually <literal>widget->window</literal>).
|
||||
* - Widget coordinates: Coordinates relative to the widget (usually `widget->window`).
|
||||
*
|
||||
* - Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.
|
||||
*
|
||||
@ -13325,7 +13325,7 @@ gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view,
|
||||
* @tree_view: A #GtkTreeView
|
||||
*
|
||||
* Returns the window that @tree_view renders to.
|
||||
* This is used primarily to compare to <literal>event->window</literal>
|
||||
* This is used primarily to compare to `event->window`
|
||||
* to confirm that the event on @tree_view is on the right window.
|
||||
*
|
||||
* Return value: (transfer none): A #GdkWindow, or %NULL when @tree_view
|
||||
@ -13352,8 +13352,8 @@ gtk_tree_view_get_bin_window (GtkTreeView *tree_view)
|
||||
* Finds the path at the point (@x, @y), relative to bin_window coordinates
|
||||
* (please see gtk_tree_view_get_bin_window()).
|
||||
* That is, @x and @y are relative to an events coordinates. @x and @y must
|
||||
* come from an event on the @tree_view only where <literal>event->window ==
|
||||
* gtk_tree_view_get_bin_window (<!-- -->)</literal>. It is primarily for
|
||||
* come from an event on the @tree_view only where `event->window ==
|
||||
* gtk_tree_view_get_bin_window (<!-- -->)`. It is primarily for
|
||||
* things like popup menus. If @path is non-%NULL, then it will be filled
|
||||
* with the #GtkTreePath at that point. This path should be freed with
|
||||
* gtk_tree_path_free(). If @column is non-%NULL, then it will be filled
|
||||
@ -13992,7 +13992,7 @@ gtk_tree_view_get_visible_range (GtkTreeView *tree_view,
|
||||
*
|
||||
* The @x and @y coordinate that are provided must be relative to bin_window
|
||||
* coordinates. That is, @x and @y must come from an event on @tree_view
|
||||
* where <literal>event->window == gtk_tree_view_get_bin_window (<!-- -->)</literal>.
|
||||
* where `event->window == gtk_tree_view_get_bin_window (<!-- -->)`.
|
||||
*
|
||||
* For converting widget coordinates (eg. the ones you get from
|
||||
* GtkWidget::query-tooltip), please see
|
||||
|
@ -4114,8 +4114,8 @@ gtk_widget_thaw_child_notify (GtkWidget *widget)
|
||||
*
|
||||
* This is a convenience function for creating a widget and setting
|
||||
* its properties in one go. For example you might write:
|
||||
* <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
|
||||
* 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
|
||||
* `gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
|
||||
* 0.0, NULL)` to create a left-aligned label. Equivalent to
|
||||
* g_object_new(), but returns a widget so you don't have to
|
||||
* cast the object yourself.
|
||||
*
|
||||
@ -10734,7 +10734,7 @@ gtk_widget_add_device_events (GtkWidget *widget,
|
||||
* returned widget; it should not be unreferenced.
|
||||
*
|
||||
* Note the difference in behavior vs. gtk_widget_get_ancestor();
|
||||
* <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
|
||||
* `gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)`
|
||||
* would return
|
||||
* %NULL if @widget wasn't inside a toplevel window, and if the
|
||||
* window was inside a #GtkWindow<!-- -->-derived widget which was in turn
|
||||
@ -10773,7 +10773,7 @@ gtk_widget_get_toplevel (GtkWidget *widget)
|
||||
* @widget_type: ancestor type
|
||||
*
|
||||
* Gets the first ancestor of @widget with type @widget_type. For example,
|
||||
* <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
|
||||
* `gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)` gets
|
||||
* the first #GtkBox that's an ancestor of @widget. No reference will be
|
||||
* added to the returned widget; it should not be unreferenced. See note
|
||||
* about checking for a toplevel #GtkWindow in the docs for
|
||||
@ -14409,8 +14409,8 @@ gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
|
||||
* The widgets in the list are not individually referenced. If you
|
||||
* want to iterate through the list and perform actions involving
|
||||
* callbacks that might destroy the widgets, you
|
||||
* must call <literal>g_list_foreach (result,
|
||||
* (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
|
||||
* must call `g_list_foreach (result,
|
||||
* (GFunc)g_object_ref, NULL)` first, and then unref all the
|
||||
* widgets afterwards.
|
||||
|
||||
* Return value: (element-type GtkWidget) (transfer container): the list of
|
||||
|
@ -2511,7 +2511,7 @@ gtk_window_activate_focus (GtkWindow *window)
|
||||
* Retrieves the current focused widget within the window.
|
||||
* Note that this is the widget that would have the focus
|
||||
* if the toplevel window focused; if the toplevel window
|
||||
* is not focused then <literal>gtk_widget_has_focus (widget)</literal> will
|
||||
* is not focused then `gtk_widget_has_focus (widget)` will
|
||||
* not be %TRUE for the widget.
|
||||
*
|
||||
* Return value: (transfer none): the currently focused widget, or %NULL if there is none.
|
||||
@ -2629,7 +2629,7 @@ gtk_window_get_modal (GtkWindow *window)
|
||||
* in the list are not individually referenced. If you want
|
||||
* to iterate through the list and perform actions involving
|
||||
* callbacks that might destroy the widgets, you must call
|
||||
* <literal>g_list_foreach (result, (GFunc)g_object_ref, NULL)</literal> first, and
|
||||
* `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and
|
||||
* then unref all the widgets afterwards.
|
||||
*
|
||||
* Return value: (element-type GtkWidget) (transfer container): list of toplevel widgets
|
||||
@ -4949,8 +4949,8 @@ gtk_window_get_size (GtkWindow *window,
|
||||
* the bottom-right corner of the window border will be placed at that
|
||||
* reference point. So, to place a window in the bottom right corner
|
||||
* you would first set gravity to south east, then write:
|
||||
* <literal>gtk_window_move (window, gdk_screen_width () - window_width,
|
||||
* gdk_screen_height () - window_height)</literal> (note that this
|
||||
* `gtk_window_move (window, gdk_screen_width () - window_width,
|
||||
* gdk_screen_height () - window_height)` (note that this
|
||||
* example does not take multi-head scenarios into account).
|
||||
*
|
||||
* The Extended Window Manager Hints specification at <ulink
|
||||
|
Loading…
Reference in New Issue
Block a user