diff --git a/docs/reference/gtk/tmpl/gtkiconview.sgml b/docs/reference/gtk/tmpl/gtkiconview.sgml deleted file mode 100644 index 2dad9dacdd..0000000000 --- a/docs/reference/gtk/tmpl/gtkiconview.sgml +++ /dev/null @@ -1,771 +0,0 @@ - -GtkIconView - - -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. - - - - - - - - - - - - - - - -The GtkIconView struct contains only -private fields and should not be directly accessed. - - - - - - - - -@iconview: the object which received the signal. -@Returns: - - - - - - -@iconview: the object which received the signal. -@arg1: - - - - - - -@iconview: the object which received the signal. -@arg1: -@arg2: -@Returns: - - - - - - -@iconview: the object which received the signal. - - - - - - -@iconview: the object which received the signal. - - - - - - -@iconview: the object which received the signal. - - - - - - -@iconview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@iconview: the object which received the signal. - - - - - - -@iconview: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -A function used by gtk_icon_view_selected_foreach() to map all -selected rows. It will be called on every selected row in the view. - - -@icon_view: a #GtkIconView -@path: The #GtkTreePath of a selected row -@data: user data - - - - - - - -@void: -@Returns: - - - - - - - -@model: -@Returns: - - - - - - - -@icon_view: -@model: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@column: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@column: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@column: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@x: -@y: -@Returns: - - - - - - - -@icon_view: -@x: -@y: -@path: -@cell: -@Returns: - - - - - - - -@icon_view: -@wx: -@wy: -@bx: -@by: - - - - - - - -@icon_view: -@path: -@cell: -@start_editing: - - - - - - - -@icon_view: -@path: -@cell: -@Returns: - - - - - - - -@icon_view: -@func: -@data: - - - - - - - -@icon_view: -@mode: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@orientation: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@columns: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@item_width: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@spacing: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@row_spacing: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@column_spacing: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@margin: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@item_padding: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@path: - - - - - - - -@icon_view: -@path: - - - - - - - -@icon_view: -@path: -@Returns: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: - - - - - - - -@icon_view: - - - - - - - -@icon_view: -@path: - - - - - - - -@icon_view: -@path: -@use_align: -@row_align: -@col_align: - - - - - - - -@icon_view: -@start_path: -@end_path: -@Returns: - - - - - - - -@icon_view: -@tooltip: -@path: - - - - - - - -@icon_view: -@tooltip: -@path: -@cell: - - - - - - - -@icon_view: -@x: -@y: -@keyboard_tip: -@model: -@path: -@iter: -@Returns: - - - - - - - -@icon_view: -@column: - - - - - - - -@icon_view: -@Returns: - - - - -An enum for determining where a dropped item goes. - - -@GTK_ICON_VIEW_NO_DROP: no drop possible -@GTK_ICON_VIEW_DROP_INTO: dropped item replaces the item -@GTK_ICON_VIEW_DROP_LEFT: droppped item is inserted to the left -@GTK_ICON_VIEW_DROP_RIGHT: dropped item is inserted to the right -@GTK_ICON_VIEW_DROP_ABOVE: dropped item is inserted above -@GTK_ICON_VIEW_DROP_BELOW: dropped item is inserted below - - - - - - -@icon_view: -@start_button_mask: -@targets: -@n_targets: -@actions: - - - - - - - -@icon_view: -@targets: -@n_targets: -@actions: - - - - - - - -@icon_view: - - - - - - - -@icon_view: - - - - - - - -@icon_view: -@reorderable: - - - - - - - -@icon_view: -@Returns: - - - - - - - -@icon_view: -@path: -@pos: - - - - - - - -@icon_view: -@path: -@pos: - - - - - - - -@icon_view: -@drag_x: -@drag_y: -@path: -@pos: -@Returns: - - - - - - - -@icon_view: -@path: -@Returns: - - diff --git a/docs/reference/gtk/tmpl/gtkstatusbar.sgml b/docs/reference/gtk/tmpl/gtkstatusbar.sgml deleted file mode 100644 index 2d860995e3..0000000000 --- a/docs/reference/gtk/tmpl/gtkstatusbar.sgml +++ /dev/null @@ -1,165 +0,0 @@ - -GtkStatusbar - - -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 context -id 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(). - - - - - - - - - - - - - -Contains private data that should be modified with the functions described -below. - - - - - - - - -@statusbar: -@context_id: -@text: - - - - - - -@statusbar: -@context_id: -@text: - - - - - - - - - - - - - - - - -@void: -@Returns: - - - - - - - -@statusbar: -@context_description: -@Returns: - - - - - - - -@statusbar: -@context_id: -@text: -@Returns: - - - - - - - -@statusbar: -@context_id: - - - - - - - -@statusbar: -@context_id: -@message_id: - - - - - - - -@statusbar: -@setting: - - - - - - - -@statusbar: -@Returns: - - - - - - - -@statusbar: -@Returns: - - diff --git a/docs/reference/gtk/tmpl/gtkwindow.sgml b/docs/reference/gtk/tmpl/gtkwindow.sgml deleted file mode 100644 index 07c39b05b8..0000000000 --- a/docs/reference/gtk/tmpl/gtkwindow.sgml +++ /dev/null @@ -1,1161 +0,0 @@ - -GtkWindow - - -Toplevel which can contain other widgets - - - - - - -GtkWindow as GtkBuildable - -The GtkWindow implementation of the GtkBuildable interface supports a -custom <accel-groups> element, which supports any number of <group> -elements representing the GtkAccelGroup objects you want to add to your -window (synonymous with gtk_window_add_accel_group(). - - -A UI definition fragment with accel groups - - - - - - -... - - -]]> - - - - - - - - - - - - - - - - - - - - - - - - - -@window: the object which received the signal. - - - - - - -@window: the object which received the signal. - - - - - - -@window: the object which received the signal. -@event: -@Returns: - - - - - - -@window: the object which received the signal. - - - - - - -@window: the object which received the signal. -@widget: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@type: -@Returns: - - - - - - - -@window: -@title: - - - - - - - -@window: -@wmclass_name: -@wmclass_class: - - - - - - - -@window: -@resizable: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@accel_group: - - - - - - - -@window: -@accel_group: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@modal: - - - - - - - -@window: -@width: -@height: - - - - - - - -@window: -@geometry_widget: -@geometry: -@geom_mask: - - - - - - - -@window: -@gravity: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@position: - - - - - - - -@window: -@parent: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@screen: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@void: -@Returns: - - - - - - - -@window: -@keyval: -@target: - - - - - - - -@window: -@keyval: -@target: - - - - - - - -@window: -@keyval: -@modifier: -@Returns: - - - - - - - -@window: -@event: -@Returns: - - - - - - - -@window: -@event: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@focus: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@default_widget: - - - - - - - -@window: - - - - - - - -@window: -@timestamp: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@edge: -@button: -@root_x: -@root_y: -@timestamp: - - - - - - - -@window: -@button: -@root_x: -@root_y: -@timestamp: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@left: -@top: -@right: -@bottom: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@modifier: - - - - - - - -@window: -@hint: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@setting: - - - - - - - -@window: -@startup_id: - - - - - - - -@window: -@role: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@void: -@Returns: - - - - - - - -@void: -@Returns: - - - - - - - -@window: -@width: -@height: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@left: -@top: -@right: -@bottom: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@root_x: -@root_y: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@width: -@height: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@x: -@y: - - - - - - - -@window: -@geometry: -@Returns: - - - - - - - -@window: - - - - - - - -@window: -@width: -@height: - - - - - - - -@list: - - - - - - - -@icon: - - - - - - - -@filename: -@err: -@Returns: - - - - - - - -@name: - - - - - - - -@window: -@icon: - - - - - - - -@window: -@list: - - - - - - - -@window: -@filename: -@err: -@Returns: - - - - - - - -@window: -@name: - - - - - - - -@setting: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@opacity: - - - - - - - -@window: -@Returns: - - - - - - - -@window: -@setting: - - diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c index cdbd9cfe92..b46e660e6d 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 81d28d02c8..2556c149dd 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 + * context id 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 875d80d65b..62c655dd3a 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 942c30e5ff..3e5b24a59d 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 + * + * + * GtkWindow as GtkBuildable + * + * The GtkWindow implementation of the GtkBuildable interface supports a + * custom accel-groups element, which supports + * any number of group elements representing the + * #GtkAccelGroup objects you want to add to your window (synonymous with + * gtk_window_add_accel_group(). + * + * + * A UI definition fragment with accel groups + * + * + * + * + * + * + * ... + * + * + * ]]> + * + * + */ enum { SET_FOCUS, FRAME_EVENT,