forked from AuroraMiddleware/gtk
docs: Move documentation to inline comments: GtkToolbar
This commit is contained in:
Javier Jardón
parent
5fcf06bb91
commit
3846988211
1
docs/reference/gtk/tmpl/.gitignore
vendored
1
docs/reference/gtk/tmpl/.gitignore
vendored
@ -40,6 +40,7 @@ gtktesting.sgml
|
|||||||
gtktextiter.sgml
|
gtktextiter.sgml
|
||||||
gtktexttagtable.sgml
|
gtktexttagtable.sgml
|
||||||
gtktoggleaction.sgml
|
gtktoggleaction.sgml
|
||||||
|
gtktoolbar.sgml
|
||||||
gtktoolitem.sgml
|
gtktoolitem.sgml
|
||||||
gtktreednd.sgml
|
gtktreednd.sgml
|
||||||
gtktypeutils.sgml
|
gtktypeutils.sgml
|
||||||
|
|||||||
@ -1,305 +0,0 @@
|
|||||||
<!-- ##### SECTION Title ##### -->
|
|
||||||
GtkToolbar
|
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
|
||||||
Create bars of buttons and other widgets
|
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
|
||||||
<para>
|
|
||||||
A toolbar is created with a call to gtk_toolbar_new().
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
A toolbar can contain instances of a subclass of #GtkToolItem. To add
|
|
||||||
a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove
|
|
||||||
an item from the toolbar use gtk_container_remove(). To add a button
|
|
||||||
to the toolbar, add an instance of #GtkToolButton.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
Toolbar items can be visually grouped by adding instances of
|
|
||||||
#GtkSeparatorToolItem to the toolbar. If a #GtkSeparatorToolItem has
|
|
||||||
the "expand" property set to #TRUE and the "draw" property set to
|
|
||||||
#FALSE the effect is to force all following items to the end of the
|
|
||||||
toolbar.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
Creating a context menu for the toolbar can be done by connecting to
|
|
||||||
the #GtkToolbar::popup-context-menu signal.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### SECTION See_Also ##### -->
|
|
||||||
<para>
|
|
||||||
<variablelist>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term>#GtkToolItem</term>
|
|
||||||
<listitem><para>Base class of widgets that can be added to a toolbar.</para></listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
</variablelist>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### SECTION Stability_Level ##### -->
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### SECTION Image ##### -->
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### STRUCT GtkToolbar ##### -->
|
|
||||||
<para>
|
|
||||||
The #GtkToolbar struct only contains private data and should only be
|
|
||||||
accessed through the function described below.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar: the object which received the signal.
|
|
||||||
@arg1:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
<!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar: the object which received the signal.
|
|
||||||
@orientation: the new #GtkOrientation of the toolbar.
|
|
||||||
|
|
||||||
<!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar: the object which received the signal.
|
|
||||||
@Returns:
|
|
||||||
@Returns:
|
|
||||||
@Returns:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
<!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@style:
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:icon-size ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:icon-size-set ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:show-arrow ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:toolbar-style ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:expand ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:homogeneous ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:button-relief ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:internal-padding ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:max-child-expand ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:shadow-type ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:space-size ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GtkToolbar:space-style ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@GTK_TOOLBAR_SPACE_EMPTY:
|
|
||||||
@GTK_TOOLBAR_SPACE_LINE:
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_new ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@void:
|
|
||||||
@Returns: the newly-created toolbar.
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_insert ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@item:
|
|
||||||
@pos:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_item_index ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@item:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_n_items ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_nth_item ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@n:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_drop_index ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@x:
|
|
||||||
@y:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_set_drop_highlight_item ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@tool_item:
|
|
||||||
@index_:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@show_arrow:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@style:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
@icon_size:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@toolbar:
|
|
||||||
|
|
||||||
|
|
||||||
@ -59,6 +59,29 @@
|
|||||||
#include "gtkintl.h"
|
#include "gtkintl.h"
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SECTION:gtktoolbar
|
||||||
|
* @Short_description: Create bars of buttons and other widgets
|
||||||
|
* @Title: GtkToolbar
|
||||||
|
* @See_also: #GtkToolItem
|
||||||
|
*
|
||||||
|
* A toolbar is created with a call to gtk_toolbar_new().
|
||||||
|
*
|
||||||
|
* A toolbar can contain instances of a subclass of #GtkToolItem. To add
|
||||||
|
* a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove
|
||||||
|
* an item from the toolbar use gtk_container_remove(). To add a button
|
||||||
|
* to the toolbar, add an instance of #GtkToolButton.
|
||||||
|
*
|
||||||
|
* Toolbar items can be visually grouped by adding instances of
|
||||||
|
* #GtkSeparatorToolItem to the toolbar. If the GtkToolbar child property
|
||||||
|
* "expand" is #TRUE and the property #GtkSeparatorToolItem:draw is set to
|
||||||
|
* #FALSE, the effect is to force all following items to the end of the toolbar.
|
||||||
|
*
|
||||||
|
* Creating a context menu for the toolbar can be done by connecting to
|
||||||
|
* the #GtkToolbar::popup-context-menu signal.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
typedef struct _ToolbarContent ToolbarContent;
|
typedef struct _ToolbarContent ToolbarContent;
|
||||||
|
|
||||||
#define DEFAULT_IPADDING 0
|
#define DEFAULT_IPADDING 0
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user