diff options
Diffstat (limited to 'docs/reference/gtk/tmpl')
22 files changed, 358 insertions, 44 deletions
diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index bd4999a4a3..35265757e2 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -1122,6 +1122,30 @@ and its unique identifying integer. @nparams: @params: +<!-- ##### SIGNAL GtkStatusbar::text-popped ##### --> +<para> +Is emitted whenever a new message is popped off a statusbar's stack. +</para> + +@statusbar: the object which received the signal. +@context_id: the context id of the relevant message/statusbar. +@text: the message that was just popped. + +<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### --> +<para> +Is emitted whenever a new message gets pushed onto a statusbar's stack. +</para> + +@statusbar: the object which received the signal. +@context_id: the context id of the relevant message/statusbar. +@text: the message that was pushed. + +<!-- ##### ARG GtkStatusbar:shadow-type ##### --> +<para> + +</para> + + <!-- ##### STRUCT GtkStatusbarMsg ##### --> <para> Holds the data for a statusbar message. <structfield>text</structfield> holds the actual text string. <structfield>context_id</structfield> is the context that this message is associated with, and <structfield>message_id</structfield> is this particular message's identifier. However, these fields should not be modified directly. diff --git a/docs/reference/gtk/tmpl/gtkaccelgroup.sgml b/docs/reference/gtk/tmpl/gtkaccelgroup.sgml index d9d3fa10e5..49e042ce16 100644 --- a/docs/reference/gtk/tmpl/gtkaccelgroup.sgml +++ b/docs/reference/gtk/tmpl/gtkaccelgroup.sgml @@ -98,6 +98,17 @@ Deprecated equivalent of g_object_unref(). @Returns: +<!-- ##### USER_FUNCTION GtkAccelGroupFindFunc ##### --> +<para> + +</para> + +@key: +@closure: +@data: +@Returns: + + <!-- ##### FUNCTION gtk_accel_group_disconnect ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkbox.sgml b/docs/reference/gtk/tmpl/gtkbox.sgml index bfdad588d9..3ad6e766b1 100644 --- a/docs/reference/gtk/tmpl/gtkbox.sgml +++ b/docs/reference/gtk/tmpl/gtkbox.sgml @@ -131,6 +131,9 @@ field.</entry> </tbody></tgroup></informaltable> </para> +@children: +@spacing: +@homogeneous: <!-- ##### STRUCT GtkBoxChild ##### --> <para>
diff --git a/docs/reference/gtk/tmpl/gtkbutton.sgml b/docs/reference/gtk/tmpl/gtkbutton.sgml index 1b60ff31a0..a78809fd4b 100644 --- a/docs/reference/gtk/tmpl/gtkbutton.sgml +++ b/docs/reference/gtk/tmpl/gtkbutton.sgml @@ -29,7 +29,8 @@ This should not be accessed directly. Use the accessor functions below. <!-- ##### FUNCTION gtk_button_new ##### --> <para> -Creates a new #GtkButton widget. +Creates a new #GtkButton widget. To add a child widget to the button, +use gtk_container_add(). </para> @Returns: The newly created #GtkButton widget. diff --git a/docs/reference/gtk/tmpl/gtkdialog.sgml b/docs/reference/gtk/tmpl/gtkdialog.sgml index 24dc48ecd3..9fafa89c2b 100644 --- a/docs/reference/gtk/tmpl/gtkdialog.sgml +++ b/docs/reference/gtk/tmpl/gtkdialog.sgml @@ -130,8 +130,8 @@ response from the user.</para></listitem> <structfield>vbox</structfield> is a #GtkVBox - the main part of the dialog box. </para> -<para> +<para> <structfield>action_area</structfield> is a #GtkHButtonBox packed below the dividing #GtkHSeparator in the dialog. It is treated exactly the same as any other #GtkHButtonBox. diff --git a/docs/reference/gtk/tmpl/gtkiconfactory.sgml b/docs/reference/gtk/tmpl/gtkiconfactory.sgml index 653d7268da..f36190f014 100644 --- a/docs/reference/gtk/tmpl/gtkiconfactory.sgml +++ b/docs/reference/gtk/tmpl/gtkiconfactory.sgml @@ -221,6 +221,18 @@ looking up the icon to use for a given stock ID. @alias: +<!-- ##### FUNCTION gtk_icon_size_lookup_for_settings ##### --> +<para> + +</para> + +@settings: +@size: +@width: +@height: +@Returns: + + <!-- ##### FUNCTION gtk_icon_size_register ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkliststore.sgml b/docs/reference/gtk/tmpl/gtkliststore.sgml index fc8d5d30f0..149c389149 100644 --- a/docs/reference/gtk/tmpl/gtkliststore.sgml +++ b/docs/reference/gtk/tmpl/gtkliststore.sgml @@ -167,3 +167,42 @@ drop</link> interfaces. @list_store: +<!-- ##### FUNCTION gtk_list_store_iter_is_valid ##### --> +<para> + +</para> + +@list_store: +@iter: +@Returns: + + +<!-- ##### FUNCTION gtk_list_store_reorder ##### --> +<para> + +</para> + +@store: +@new_order: + + +<!-- ##### FUNCTION gtk_list_store_swap ##### --> +<para> + +</para> + +@store: +@a: +@b: + + +<!-- ##### FUNCTION gtk_list_store_move ##### --> +<para> + +</para> + +@store: +@iter: +@position: + + diff --git a/docs/reference/gtk/tmpl/gtkmain.sgml b/docs/reference/gtk/tmpl/gtkmain.sgml index 885a793d99..0dd8d6509d 100644 --- a/docs/reference/gtk/tmpl/gtkmain.sgml +++ b/docs/reference/gtk/tmpl/gtkmain.sgml @@ -289,6 +289,14 @@ cleaned from any arguments that GTK+ handles itself. @argv: Points to the argument vector. +<!-- ##### USER_FUNCTION GtkModuleDisplayInitFunc ##### --> +<para> + +</para> + +@display: + + <!-- ##### FUNCTION gtk_true ##### --> <para> All this function does it to return %TRUE. This can be useful for example diff --git a/docs/reference/gtk/tmpl/gtkmenu.sgml b/docs/reference/gtk/tmpl/gtkmenu.sgml index d5aa97fd46..10d49af0c7 100644 --- a/docs/reference/gtk/tmpl/gtkmenu.sgml +++ b/docs/reference/gtk/tmpl/gtkmenu.sgml @@ -151,21 +151,15 @@ Moves a #GtkMenuItem to a new position within the #GtkMenu. <!-- ##### FUNCTION gtk_menu_popup ##### --> -<para> -Displays a menu and makes it available for selection. Applications can use -this function to display context-sensitive menus, and will typically supply -%NULL for the @parent_menu_shell, @parent_menu_item, @func and @data -parameters. The default menu positioning function will position the menu -at the current pointer position. -</para> -@menu: a #GtkMenu. -@parent_menu_shell: the menu shell containing the triggering menu item. -@parent_menu_item: the menu item whose activation triggered the popup. -@func: a user supplied function used to position the menu. -@data: user supplied data to be passed to @func. -@button: the button which was pressed to initiate the event. -@activate_time: the time at which the activation event occurred. + +@menu: +@parent_menu_shell: +@parent_menu_item: +@func: +@data: +@button: +@activate_time: <!-- ##### FUNCTION gtk_menu_set_accel_group ##### --> diff --git a/docs/reference/gtk/tmpl/gtkmenushell.sgml b/docs/reference/gtk/tmpl/gtkmenushell.sgml index 08e9490a48..e5009d44be 100644 --- a/docs/reference/gtk/tmpl/gtkmenushell.sgml +++ b/docs/reference/gtk/tmpl/gtkmenushell.sgml @@ -89,6 +89,15 @@ Selects the menu item from the menu shell. @menu_item: The #GtkMenuItem to select. +<!-- ##### FUNCTION gtk_menu_shell_select_first ##### --> +<para> + +</para> + +@menu_shell: +@search_sensitive: + + <!-- ##### FUNCTION gtk_menu_shell_deselect ##### --> <para> Deselects the currently selected item from the menu shell, if any. diff --git a/docs/reference/gtk/tmpl/gtknotebook.sgml b/docs/reference/gtk/tmpl/gtknotebook.sgml index 963da3141a..6694ba7be5 100644 --- a/docs/reference/gtk/tmpl/gtknotebook.sgml +++ b/docs/reference/gtk/tmpl/gtknotebook.sgml @@ -244,6 +244,15 @@ gtk_notebook_set_current_page() instead. @Returns: +<!-- ##### FUNCTION gtk_notebook_get_n_pages ##### --> +<para> + +</para> + +@notebook: +@Returns: + + <!-- ##### FUNCTION gtk_notebook_get_tab_label ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkpaned.sgml b/docs/reference/gtk/tmpl/gtkpaned.sgml index aa1d425e8b..3fe425c216 100644 --- a/docs/reference/gtk/tmpl/gtkpaned.sgml +++ b/docs/reference/gtk/tmpl/gtkpaned.sgml @@ -58,8 +58,8 @@ gtk_widget_set_size_request (hpaned, 200 + GTK_PANED (hpaned)->gutter_size, -1); gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE); gtk_widget_set_size_request (frame1, 50, -1); -gtk_paned_pack2 (GTK_PANED (hpaned), frame1, FALSE, FALSE); -gtk_widget_set_size_request (frame1, 50, -1); +gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE); +gtk_widget_set_size_request (frame2, 50, -1); </programlisting> </example> diff --git a/docs/reference/gtk/tmpl/gtkstatusbar.sgml b/docs/reference/gtk/tmpl/gtkstatusbar.sgml index 4d7ea2688b..0d575b6cc3 100644 --- a/docs/reference/gtk/tmpl/gtkstatusbar.sgml +++ b/docs/reference/gtk/tmpl/gtkstatusbar.sgml @@ -51,6 +51,15 @@ The message at the top of the stack can be removed using gtk_statusbar_pop(). A Contains private data that should be modified with the functions described below. </para> +@parent_widget: +@frame: +@label: +@messages: +@keys: +@seq_context_id: +@seq_message_id: +@grip_window: +@has_resize_grip: <!-- ##### FUNCTION gtk_statusbar_new ##### --> <para> @@ -120,26 +129,3 @@ Returns whether the statusbar has a resize grip. @Returns: %TRUE if the statusbar has a resize grip. -<!-- ##### SIGNAL GtkStatusbar::text-popped ##### --> -<para> -Is emitted whenever a new message is popped off a statusbar's stack. -</para> - -@statusbar: the object which received the signal. -@context_id: the context id of the relevant message/statusbar. -@text: the message that was just popped. - -<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### --> -<para> -Is emitted whenever a new message gets pushed onto a statusbar's stack. -</para> - -@statusbar: the object which received the signal. -@context_id: the context id of the relevant message/statusbar. -@text: the message that was pushed. - -<!-- ##### ARG GtkStatusbar:shadow-type ##### --> -<para> - -</para> - diff --git a/docs/reference/gtk/tmpl/gtkstock.sgml b/docs/reference/gtk/tmpl/gtkstock.sgml index afb8578a62..64a1108bd3 100644 --- a/docs/reference/gtk/tmpl/gtkstock.sgml +++ b/docs/reference/gtk/tmpl/gtkstock.sgml @@ -151,6 +151,13 @@ The "Close" item. +<!-- ##### MACRO GTK_STOCK_COLOR_PICKER ##### --> +<para> + +</para> + + + <!-- ##### MACRO GTK_STOCK_CONVERT ##### --> <para> The "Convert" item. diff --git a/docs/reference/gtk/tmpl/gtktable.sgml b/docs/reference/gtk/tmpl/gtktable.sgml index 57ef0d0b43..7fda888960 100644 --- a/docs/reference/gtk/tmpl/gtktable.sgml +++ b/docs/reference/gtk/tmpl/gtktable.sgml @@ -135,8 +135,8 @@ and row numbers of the table. (Columns and rows are indexed from zero). @child: The widget to add. @left_attach: the column number to attach the left side of a child widget to. @right_attach: the column number to attach the right side of a child widget to. -@top_attach: the row number to attach the left side of a child widget to. -@bottom_attach: the column number to attach the right side of a child widget to. +@top_attach: the row number to attach the top of a child widget to. +@bottom_attach: the column number to attach the bottom of a child widget to. @xoptions: Used to specify the properties of the child widget when the table is resized. @yoptions: The same as xoptions, except this field determines behaviour of vertical resizing. @xpadding: An integer value specifying the padding on the left and right of the widget being added to the table. diff --git a/docs/reference/gtk/tmpl/gtktreemodel.sgml b/docs/reference/gtk/tmpl/gtktreemodel.sgml index 902ea0911f..4ebe443567 100644 --- a/docs/reference/gtk/tmpl/gtktreemodel.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodel.sgml @@ -125,7 +125,7 @@ the second is much more common, as you often get paths from callbacks. parent_iter = iter; gtk_tree_model_get_nth_child (model, &iter, &parent_iter, 2); parent_iter = iter; - gtk_tree_model_get_nth_child (model, &iter, NULL, 5); + gtk_tree_model_get_nth_child (model, &iter, &parent_iter, 5); } </programlisting> </example> @@ -291,6 +291,16 @@ section. @Returns: +<!-- ##### FUNCTION gtk_tree_path_new_from_indices ##### --> +<para> + +</para> + +@first_index: +@Varargs: +@Returns: + + <!-- ##### FUNCTION gtk_tree_path_to_string ##### --> <para> @@ -482,6 +492,15 @@ versions of GTK+. @reference: +<!-- ##### FUNCTION gtk_tree_row_reference_copy ##### --> +<para> + +</para> + +@reference: +@Returns: + + <!-- ##### FUNCTION gtk_tree_row_reference_inserted ##### --> <para> @@ -685,6 +704,16 @@ versions of GTK+. @Returns: +<!-- ##### FUNCTION gtk_tree_model_get_string_from_iter ##### --> +<para> + +</para> + +@tree_model: +@iter: +@Returns: + + <!-- ##### FUNCTION gtk_tree_model_ref_node ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtktreemodelsort.sgml b/docs/reference/gtk/tmpl/gtktreemodelsort.sgml index fc2d4cce79..1bea6a9297 100644 --- a/docs/reference/gtk/tmpl/gtktreemodelsort.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodelsort.sgml @@ -98,6 +98,16 @@ GtkTreeModelSort @tree_model_sort: +<!-- ##### FUNCTION gtk_tree_model_sort_iter_is_valid ##### --> +<para> + +</para> + +@tree_model_sort: +@iter: +@Returns: + + <!-- ##### ARG GtkTreeModelSort:model ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtktreeselection.sgml b/docs/reference/gtk/tmpl/gtktreeselection.sgml index efb2dd085d..b88d04c3aa 100644 --- a/docs/reference/gtk/tmpl/gtktreeselection.sgml +++ b/docs/reference/gtk/tmpl/gtktreeselection.sgml @@ -142,6 +142,25 @@ selected rows. It will be called on every selected row in the view. @data: +<!-- ##### FUNCTION gtk_tree_selection_get_selected_rows ##### --> +<para> + +</para> + +@selection: +@model: +@Returns: + + +<!-- ##### FUNCTION gtk_tree_selection_count_selected_rows ##### --> +<para> + +</para> + +@selection: +@Returns: + + <!-- ##### FUNCTION gtk_tree_selection_select_path ##### --> <para> @@ -224,6 +243,16 @@ selected rows. It will be called on every selected row in the view. @end_path: +<!-- ##### FUNCTION gtk_tree_selection_unselect_range ##### --> +<para> + +</para> + +@selection: +@start_path: +@end_path: + + <!-- ##### SIGNAL GtkTreeSelection::changed ##### --> <para> Emitted whenever the selection has (possibly) changed. Please note that diff --git a/docs/reference/gtk/tmpl/gtktreestore.sgml b/docs/reference/gtk/tmpl/gtktreestore.sgml index d1fdc867de..8ce862f456 100644 --- a/docs/reference/gtk/tmpl/gtktreestore.sgml +++ b/docs/reference/gtk/tmpl/gtktreestore.sgml @@ -173,3 +173,43 @@ GtkTreeStore @tree_store: +<!-- ##### FUNCTION gtk_tree_store_iter_is_valid ##### --> +<para> + +</para> + +@tree_store: +@iter: +@Returns: + + +<!-- ##### FUNCTION gtk_tree_store_reorder ##### --> +<para> + +</para> + +@tree_store: +@parent: +@new_order: + + +<!-- ##### FUNCTION gtk_tree_store_swap ##### --> +<para> + +</para> + +@tree_store: +@a: +@b: + + +<!-- ##### FUNCTION gtk_tree_store_move ##### --> +<para> + +</para> + +@tree_store: +@iter: +@position: + + diff --git a/docs/reference/gtk/tmpl/gtktreeview.sgml b/docs/reference/gtk/tmpl/gtktreeview.sgml index 62f5fc3ac3..4d4de6b298 100644 --- a/docs/reference/gtk/tmpl/gtktreeview.sgml +++ b/docs/reference/gtk/tmpl/gtktreeview.sgml @@ -377,6 +377,18 @@ Function used for #gtk_tree_view_map_expanded_rows. @start_editing: +<!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### --> +<para> + +</para> + +@tree_view: +@path: +@focus_column: +@focus_cell: +@start_editing: + + <!-- ##### FUNCTION gtk_tree_view_get_cursor ##### --> <para> @@ -413,6 +425,15 @@ Function used for #gtk_tree_view_map_expanded_rows. @tree_view: +<!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### --> +<para> + +</para> + +@tree_view: +@path: + + <!-- ##### FUNCTION gtk_tree_view_expand_row ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml index 800698d907..6710dcfd36 100644 --- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml +++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml @@ -471,6 +471,15 @@ calling gtk_tree_view_column_set_cell_data_func() @Returns: +<!-- ##### FUNCTION gtk_tree_view_column_focus_cell ##### --> +<para> + +</para> + +@tree_column: +@cell: + + <!-- ##### SIGNAL GtkTreeViewColumn::clicked ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkwindow.sgml b/docs/reference/gtk/tmpl/gtkwindow.sgml index d973842873..5376d69fed 100644 --- a/docs/reference/gtk/tmpl/gtkwindow.sgml +++ b/docs/reference/gtk/tmpl/gtkwindow.sgml @@ -403,6 +403,22 @@ Deprecated alias for gtk_window_set_position(). @window: +<!-- ##### FUNCTION gtk_window_fullscreen ##### --> +<para> + +</para> + +@window: + + +<!-- ##### FUNCTION gtk_window_unfullscreen ##### --> +<para> + +</para> + +@window: + + <!-- ##### FUNCTION gtk_window_begin_resize_drag ##### --> <para> @@ -485,6 +501,24 @@ Deprecated alias for gtk_window_set_position(). @hint: +<!-- ##### FUNCTION gtk_window_set_skip_taskbar_hint ##### --> +<para> + +</para> + +@window: +@setting: + + +<!-- ##### FUNCTION gtk_window_set_skip_pager_hint ##### --> +<para> + +</para> + +@window: +@setting: + + <!-- ##### FUNCTION gtk_window_get_decorated ##### --> <para> @@ -637,6 +671,24 @@ Deprecated alias for gtk_window_set_position(). @Returns: +<!-- ##### FUNCTION gtk_window_get_skip_taskbar_hint ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION gtk_window_get_skip_pager_hint ##### --> +<para> + +</para> + +@window: +@Returns: + + <!-- ##### FUNCTION gtk_window_move ##### --> <para> @@ -683,6 +735,16 @@ Deprecated alias for gtk_window_set_position(). @list: +<!-- ##### FUNCTION gtk_window_set_default_icon_from_file ##### --> +<para> + +</para> + +@filename: +@err: +@Returns: + + <!-- ##### FUNCTION gtk_window_set_icon ##### --> <para> @@ -701,6 +763,17 @@ Deprecated alias for gtk_window_set_position(). @list: +<!-- ##### FUNCTION gtk_window_set_icon_from_file ##### --> +<para> + +</para> + +@window: +@filename: +@err: +@Returns: + + <!-- ##### FUNCTION gtk_decorated_window_init ##### --> <para> |