mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-11-10 19:00:08 +00:00
Move documentation to inline comments: GtkStyle
This commit is contained in:
parent
f121a502f9
commit
885b6d8a75
1
docs/reference/gtk/tmpl/.gitignore
vendored
1
docs/reference/gtk/tmpl/.gitignore
vendored
@ -11,6 +11,7 @@ gtkrecentaction.sgml
|
||||
gtkscalebutton.sgml
|
||||
gtkseparator.sgml
|
||||
gtkseparatormenuitem.sgml
|
||||
gtkstyle.sgml
|
||||
gtktesting.sgml
|
||||
gtktextiter.sgml
|
||||
gtktoggleaction.sgml
|
||||
|
@ -1,647 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Styles
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Functions for drawing widget parts
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### 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>
|
||||
|
||||
@void:
|
||||
@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_set_background ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@style:
|
||||
@window:
|
||||
@state_type:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_style_apply_default_background ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@style:
|
||||
@window:
|
||||
@set_bg:
|
||||
@state_type:
|
||||
@area:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_style_lookup_color ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@style:
|
||||
@color_name:
|
||||
@color:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_style_render_icon ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@style:
|
||||
@source:
|
||||
@direction:
|
||||
@state:
|
||||
@size:
|
||||
@widget:
|
||||
@detail:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### 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_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:
|
||||
@area:
|
||||
@widget:
|
||||
@detail:
|
||||
@step:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### 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>
|
||||
|
||||
@void:
|
||||
@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:
|
||||
|
||||
|
@ -43,6 +43,26 @@
|
||||
#include "gtkalias.h"
|
||||
#include "gtkspinner.h"
|
||||
|
||||
|
||||
/**
|
||||
* SECTION:gtkstyle
|
||||
* @Short_description: An object that hold style information for widgets
|
||||
* @Title: GtkStyle
|
||||
*
|
||||
* A #GtkStyle object encapsulates the information that provides the look and
|
||||
* feel for a widget. Each #GtkWidget has an associated #GTkStyle object that
|
||||
* is used when rendering that widget. Also, a #GtkStyle holds information for
|
||||
* the five possible widget states though not every widget supports all five
|
||||
* states; see #GtkStateType.
|
||||
*
|
||||
* Usually the #GtkStyle for a widget is the same as the default style that is
|
||||
* set by GTK+ and modified the theme engine.
|
||||
*
|
||||
* Usually applications should not need to use or modify the #GtkStyle of their
|
||||
* widgets.
|
||||
*/
|
||||
|
||||
|
||||
#define LIGHTNESS_MULT 1.3
|
||||
#define DARKNESS_MULT 0.7
|
||||
|
||||
|
@ -68,6 +68,12 @@ typedef gboolean (*GtkRcPropertyParser) (const GParamSpec *pspec,
|
||||
*/
|
||||
typedef struct _GtkWidget GtkWidget;
|
||||
|
||||
/**
|
||||
* GTK_STYLE_ATTACHED:
|
||||
* @style: a #GtkStyle.
|
||||
*
|
||||
* Returns whether the style is attached to a window.
|
||||
*/
|
||||
#define GTK_STYLE_ATTACHED(style) (GTK_STYLE (style)->attach_count > 0)
|
||||
|
||||
struct _GtkStyle
|
||||
@ -429,6 +435,16 @@ struct _GtkStyleClass
|
||||
void (*_gtk_reserved11) (void);
|
||||
};
|
||||
|
||||
/**
|
||||
* GtkBorder:
|
||||
* @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.
|
||||
*
|
||||
* A struct that specifies a border around a rectangular area that can
|
||||
* be of different width on each side.
|
||||
*/
|
||||
struct _GtkBorder
|
||||
{
|
||||
gint left;
|
||||
|
Loading…
Reference in New Issue
Block a user