[gtk+] Get rid of templates that gtk-doc touches during distcheck



commit e17b9f282fb6cfb413de598350e273a68031994b
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Jun 8 19:44:56 2010 -0400

    Get rid of templates that gtk-doc touches during distcheck
    
    In an attempt to make distcheck not touch any files under source
    control.

 docs/reference/gtk/tmpl/gtkiconview.sgml  |  771 -------------------
 docs/reference/gtk/tmpl/gtkstatusbar.sgml |  165 ----
 docs/reference/gtk/tmpl/gtkwindow.sgml    | 1161 -----------------------------
 gtk/gtkiconview.c                         |   13 +
 gtk/gtkstatusbar.c                        |   38 +
 gtk/gtkstatusbar.h                        |    6 +
 gtk/gtkwindow.c                           |   30 +
 7 files changed, 87 insertions(+), 2097 deletions(-)
---
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index cdbd9cf..b46e660 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -43,6 +43,19 @@
 #include "gtkprivate.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkiconview
+ * @title: GtkIconView
+ * @short_description: A widget which displays a list of icons in a grid
+ *
+ * #GtkIconView provides an alternative view on a list model.
+ * It displays the model as a grid of icons with labels. Like
+ * #GtkTreeView, it allows to select one or multiple items
+ * (depending on the selection mode, see gtk_icon_view_set_selection_mode()).
+ * In addition to selection with the arrow keys, #GtkIconView supports
+ * rubberband selection, which is controlled by dragging the pointer.
+ */
+
 #undef DEBUG_ICON_VIEW
 
 #define SCROLL_EDGE_SIZE 15
diff --git a/gtk/gtkstatusbar.c b/gtk/gtkstatusbar.c
index 81d28d0..2556c14 100644
--- a/gtk/gtkstatusbar.c
+++ b/gtk/gtkstatusbar.c
@@ -36,6 +36,44 @@
 #include "gtkbuildable.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkstatusbar
+ * @title: GtkStatusbar
+ * @short_description: Report messages of minor importance to the user
+ *
+ * A #GtkStatusbar is usually placed along the bottom of an application's
+ * main #GtkWindow. It may provide a regular commentary of the application's
+ * status (as is usually the case in a web browser, for example), or may be
+ * used to simply output a message when the status changes, (when an upload
+ * is complete in an FTP client, for example).
+ * It may also have a resize grip (a triangular area in the lower right
+ * corner) which can be clicked on to resize the window containing the
+ * statusbar.
+ *
+ * Status bars in GTK+ maintain a stack of messages. The message at
+ * the top of the each bar's stack is the one that will currently be displayed.
+ *
+ * Any messages added to a statusbar's stack must specify a
+ * <emphasis>context id</emphasis> that is used to uniquely identify
+ * the source of a message. This context id can be generated by
+ * gtk_statusbar_get_context_id(), given a message and the statusbar that
+ * it will be added to. Note that messages are stored in a stack, and when
+ * choosing which message to display, the stack structure is adhered to,
+ * regardless of the context identifier of a message.
+ *
+ * One could say that a statusbar maintains one stack of messages for
+ * display purposes, but allows multiple message producers to maintain
+ * sub-stacks of the messages they produced (via context ids).
+ *
+ * Status bars are created using gtk_statusbar_new().
+ *
+ * Messages are added to the bar's stack with gtk_statusbar_push().
+ *
+ * The message at the top of the stack can be removed using
+ * gtk_statusbar_pop(). A message can be removed from anywhere in the
+ * stack if its message id was recorded at the time it was added. This
+ * is done using gtk_statusbar_remove().
+ */
 typedef struct _GtkStatusbarMsg GtkStatusbarMsg;
 
 struct _GtkStatusbarMsg
diff --git a/gtk/gtkstatusbar.h b/gtk/gtkstatusbar.h
index 875d80d..62c655d 100644
--- a/gtk/gtkstatusbar.h
+++ b/gtk/gtkstatusbar.h
@@ -44,6 +44,12 @@ G_BEGIN_DECLS
 #define GTK_STATUSBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_STATUSBAR, GtkStatusbarClass))
 
 
+/**
+ * GtkStatusbar:
+ *
+ * Contains private data that should be modified with the functions
+ * described below.
+ */
 typedef struct _GtkStatusbar      GtkStatusbar;
 typedef struct _GtkStatusbarClass GtkStatusbarClass;
 
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index 942c30e..3e5b24a 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -55,6 +55,36 @@
 #include "x11/gdkx.h"
 #endif
 
+/**
+ * SECTION:gtkwindow
+ * @title: GtkWindow
+ * @short_description: Toplevel which can contain other widgets
+ *
+ * <refsect2 id="GtkWindow-BUILDER-UI">
+ * <title>GtkWindow as GtkBuildable</title>
+ * <para>
+ * The GtkWindow implementation of the GtkBuildable interface supports a
+ * custom <tag class="starttag">accel-groups</tag> element, which supports
+ * any number of <tag class="starttag">group</tag> elements representing the
+ * #GtkAccelGroup objects you want to add to your window (synonymous with
+ * gtk_window_add_accel_group().
+ * </para>
+ * <example>
+ * <title>A UI definition fragment with accel groups</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkWindow">
+ *   <accel-groups>
+ *     <group name="accelgroup1"/>
+ *   </accel-groups>
+ * </object>
+ * <!-- -->
+ * ...
+ * <!-- -->
+ * <object class="GtkAccelGroup" id="accelgroup1"/>
+ * ]]></programlisting>
+ * </example>
+ * </refsect2>
+ */
 enum {
   SET_FOCUS,
   FRAME_EVENT,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]