summaryrefslogtreecommitdiff
path: root/gtk/gtkicontheme.h
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2011-04-14 22:07:29 +0100
committerJavier Jardón <jjardon@gnome.org>2011-04-15 01:41:13 +0100
commit0dd93537b309d7962938bce6143f7645e5915592 (patch)
tree367116aea62684cc269cc7fcedd7d96bbda0a96a /gtk/gtkicontheme.h
parentb097729d5a0016254fdbcde4077ba5004b1c6b30 (diff)
downloadgtk+-0dd93537b309d7962938bce6143f7645e5915592.tar.gz
Move documentation to inline comments: GtkIconTheme
Diffstat (limited to 'gtk/gtkicontheme.h')
-rw-r--r--gtk/gtkicontheme.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/gtk/gtkicontheme.h b/gtk/gtkicontheme.h
index 607bdf09e4..6d3ea2d266 100644
--- a/gtk/gtkicontheme.h
+++ b/gtk/gtkicontheme.h
@@ -40,11 +40,28 @@ G_BEGIN_DECLS
#define GTK_IS_ICON_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_THEME))
#define GTK_ICON_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_THEME, GtkIconThemeClass))
+/**
+ * GtkIconInfo:
+ *
+ * Contains information found when looking up an icon in
+ * an icon theme.
+ */
typedef struct _GtkIconInfo GtkIconInfo;
typedef struct _GtkIconTheme GtkIconTheme;
typedef struct _GtkIconThemeClass GtkIconThemeClass;
typedef struct _GtkIconThemePrivate GtkIconThemePrivate;
+/**
+ * GtkIconTheme:
+ *
+ * Acts as a database of information about an icon theme.
+ * Normally, you retrieve the icon theme for a particular
+ * screen using gtk_icon_theme_get_for_screen() and it
+ * will contain information about current icon theme for
+ * that screen, but you can also create a new #GtkIconTheme
+ * object and set the icon theme name explicitely using
+ * gtk_icon_theme_set_custom_theme().
+ */
struct _GtkIconTheme
{
/*< private >*/
@@ -94,6 +111,11 @@ typedef enum
GTK_ICON_LOOKUP_FORCE_SIZE = 1 << 4
} GtkIconLookupFlags;
+/**
+ * GTK_ICON_THEME_ERROR:
+ *
+ * The #GQuark used for #GtkIconThemeError errors.
+ */
#define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark ()
/**