summaryrefslogtreecommitdiff
path: root/gtk
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2010-05-16 00:44:58 +0200
committerJavier Jardón <jjardon@gnome.org>2010-05-16 01:37:36 +0200
commit885b6d8a75fe2d2b98e71c9f86b39cedb5ba369d (patch)
treeac9ca4f8b7ac576234223cf2f80271eaf81e7a2b /gtk
parentf121a502f9d7ff1a4449415c33a3257c81a27080 (diff)
downloadgtk+-885b6d8a75fe2d2b98e71c9f86b39cedb5ba369d.tar.gz
Move documentation to inline comments: GtkStyle
Diffstat (limited to 'gtk')
-rw-r--r--gtk/gtkstyle.c20
-rw-r--r--gtk/gtkstyle.h16
2 files changed, 36 insertions, 0 deletions
diff --git a/gtk/gtkstyle.c b/gtk/gtkstyle.c
index 53c4711f90..8a1c8cc970 100644
--- a/gtk/gtkstyle.c
+++ b/gtk/gtkstyle.c
@@ -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
diff --git a/gtk/gtkstyle.h b/gtk/gtkstyle.h
index 141cbcc379..dd8890002e 100644
--- a/gtk/gtkstyle.h
+++ b/gtk/gtkstyle.h
@@ -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;