forked from AuroraMiddleware/gtk
fcbbd763cd
The Gtk-custom.c file in gir-repository contained a number of introspection annotations. Merge those into the GTK source files. Some documentation was moved from the tmpl/ files to accomodate the addition of annotations.
1022 lines
10 KiB
Plaintext
1022 lines
10 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Styles
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Functions for drawing widget parts
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### MACRO GTK_STYLE_ATTACHED ##### -->
|
|
<para>
|
|
Returns whether the style is attached to a window.
|
|
</para>
|
|
|
|
@style: a #GtkStyle.
|
|
|
|
|
|
<!-- ##### STRUCT GtkStyle ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@fg:
|
|
@bg:
|
|
@light:
|
|
@dark:
|
|
@mid:
|
|
@text:
|
|
@base:
|
|
@text_aa:
|
|
@black:
|
|
@white:
|
|
@font_desc:
|
|
@xthickness:
|
|
@ythickness:
|
|
@fg_gc:
|
|
@bg_gc:
|
|
@light_gc:
|
|
@dark_gc:
|
|
@mid_gc:
|
|
@text_gc:
|
|
@base_gc:
|
|
@text_aa_gc:
|
|
@black_gc:
|
|
@white_gc:
|
|
@bg_pixmap:
|
|
|
|
<!-- ##### SIGNAL GtkStyle::realize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkStyle::unrealize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style: the object which received the signal.
|
|
|
|
<!-- ##### FUNCTION gtk_style_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_attach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_detach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_ref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_unref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_set_background ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_apply_default_background ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO gtk_style_apply_default_pixmap ##### -->
|
|
<para>
|
|
Does the same as gtk_style_apply_default_background().
|
|
</para>
|
|
|
|
@s:
|
|
@gw:
|
|
@st:
|
|
@a:
|
|
@x:
|
|
@y:
|
|
@w:
|
|
@h:
|
|
@Deprecated: Use gtk_style_apply_default_background() instead.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_lookup_color ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@color_name:
|
|
@color:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_lookup_icon_set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@stock_id:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_render_icon ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@source:
|
|
@direction:
|
|
@state:
|
|
@size:
|
|
@widget:
|
|
@detail:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_get_font ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_set_font ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@font:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_get_style_property ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@widget_type:
|
|
@property_name:
|
|
@value:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_get_valist ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@widget_type:
|
|
@first_property_name:
|
|
@var_args:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_style_get ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@widget_type:
|
|
@first_property_name:
|
|
@Varargs:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_hline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@x1:
|
|
@x2:
|
|
@y:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_vline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@y1_:
|
|
@y2_:
|
|
@x:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_shadow ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_polygon ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@points:
|
|
@npoints:
|
|
@fill:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_arrow ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@arrow_type:
|
|
@fill:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_diamond ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_string ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@x:
|
|
@y:
|
|
@string:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_box ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_box_gap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@gap_side:
|
|
@gap_x:
|
|
@gap_width:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_check ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_extension ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@gap_side:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_flat_box ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_focus ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_handle ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@orientation:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_option ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_shadow_gap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@gap_side:
|
|
@gap_x:
|
|
@gap_width:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_slider ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@orientation:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_tab ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_expander ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@x:
|
|
@y:
|
|
@expander_style:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_layout ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@use_text:
|
|
@x:
|
|
@y:
|
|
@layout:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_resize_grip ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@edge:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_arrow ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@arrow_type:
|
|
@fill:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_box ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_box_gap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@gap_side:
|
|
@gap_x:
|
|
@gap_width:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_check ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_diamond ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_extension ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@gap_side:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_flat_box ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_focus ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_handle ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@orientation:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_hline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x1:
|
|
@x2:
|
|
@y:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_option ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_polygon ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@points:
|
|
@n_points:
|
|
@fill:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_shadow ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_shadow_gap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@gap_side:
|
|
@gap_x:
|
|
@gap_width:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_slider ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
@orientation:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_spinner ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@step:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_string ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@string:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_tab ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@shadow_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_vline ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@y1_:
|
|
@y2_:
|
|
@x:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_expander ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@expander_style:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_layout ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@use_text:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@x:
|
|
@y:
|
|
@layout:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_paint_resize_grip ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@style:
|
|
@window:
|
|
@state_type:
|
|
@area:
|
|
@widget:
|
|
@detail:
|
|
@edge:
|
|
@x:
|
|
@y:
|
|
@width:
|
|
@height:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_draw_insertion_cursor ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@widget:
|
|
@drawable:
|
|
@area:
|
|
@location:
|
|
@is_primary:
|
|
@direction:
|
|
@draw_arrow:
|
|
|
|
|
|
<!-- ##### STRUCT GtkBorder ##### -->
|
|
<para>
|
|
A struct that specifies a border around a rectangular area that can
|
|
be of different width on each side.
|
|
</para>
|
|
|
|
@left: The width of the left border.
|
|
@right: The width of the right border.
|
|
@top: The width of the top border.
|
|
@bottom: The width of the bottom border.
|
|
|
|
<!-- ##### FUNCTION gtk_border_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_border_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@border_:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_border_free ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@border_:
|
|
|
|
|
|
<!-- ##### STRUCT GtkRcProperty ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type_name:
|
|
@property_name:
|
|
@origin:
|
|
@value:
|
|
|
|
<!-- ##### USER_FUNCTION GtkRcPropertyParser ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pspec:
|
|
@rc_string:
|
|
@property_value:
|
|
@Returns:
|
|
|
|
|