add new "is_important" property
Fri Aug 1 15:26:46 2003 Soeren Sandmann <sandmann@daimi.au.dk> * gtk/gtktoolbar.c, gtk/toolitem.c: add new "is_important" property * gtk/gtkradiotoolbutton.c (gtk_radio_tool_button_new_from_widget): Don't take a stock id * gtk/gtkradiotoolbutton.c (gtk_radio_tool_button_new_with_stock_from_widget): make this function take a stock_id. * gtk/toolbar: documentation
This commit is contained in:
committed by
Søren Sandmann Pedersen
parent
72f1116387
commit
6f6d3a2202
@ -2,21 +2,63 @@
|
||||
GtkRadioToolButton
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
A toolbar item that contains a radio button.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A #GtkRadioToolButton is a #GtkToolItem that contains a radio button,
|
||||
that is, a button that is part of a group of toggle buttons where only
|
||||
one button can be active at a time.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Use gtk_radio_tool_button_new() to create a new
|
||||
#GtkRadioToolButton. use gtk_radio_tool_button_new_from_widget() to
|
||||
create a new #GtkRadioToolButton that is part of the same group as an
|
||||
existing #GtkRadioToolButton. Use
|
||||
gtk_radio_tool_button_new_from_stock() or
|
||||
gtk_radio_tool_button_new_from_widget_with_stock() to create a new
|
||||
#GtkRAdioToolButton containing a stock item.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkToolbar</term>
|
||||
<listitem><para>The toolbar widget</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkToolButton</term>
|
||||
<listitem><para>
|
||||
An ancestor class of GtkRadioToolButton. The properties
|
||||
"label_widget", "label", "icon_widget", and "stock_id" on
|
||||
#GtkToolButton determine the label and icon used on a
|
||||
#GtkRadioToolButton.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkSeparatorToolItem</term>
|
||||
<listitem>
|
||||
<para>A subclass of #GtkToolItem that separates groups of
|
||||
items on a toolbar. It is usually a good idea to put a separator
|
||||
before and after a group of #GtkRadioToolButtons on a #GtkToolbar.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkRadioToolButton ##### -->
|
||||
<para>
|
||||
|
||||
The #GtkRadioToolButton contains only private data and should only
|
||||
be accessed through the functions described below.
|
||||
</para>
|
||||
|
||||
|
||||
@ -45,7 +87,6 @@ GtkRadioToolButton
|
||||
</para>
|
||||
|
||||
@group:
|
||||
@stock_id:
|
||||
@Returns:
|
||||
|
||||
|
||||
@ -55,6 +96,7 @@ GtkRadioToolButton
|
||||
</para>
|
||||
|
||||
@group:
|
||||
@stock_id:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
||||
@ -2,21 +2,37 @@
|
||||
GtkSeparatorToolItem
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
A toolbar item that separates groups of other toolbar items.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
A #GtkSeparatorItem is a #GtkToolItem that separates groups of other
|
||||
#GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
|
||||
often look like a vertical line on horizontally docked toolbars.
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkToolbar</term>
|
||||
<listitem><para>The toolbar widget</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkRadioToolButton</term>
|
||||
<listitem><para>A toolbar item containing a radio
|
||||
button</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkSeparatorToolItem ##### -->
|
||||
<para>
|
||||
|
||||
The #GtkSeparatorToolItem struct contains only private data and
|
||||
should only be accessed through the functions described below.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
@ -58,18 +58,22 @@ void make_toggles (void) {
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkButton</term>
|
||||
<listitem><para>a more general button.</para></listitem>
|
||||
<term>#GtkButton</term>
|
||||
<listitem><para>a more general button.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkCheckButton</term>
|
||||
<listitem><para>another way of presenting a toggle option.</para></listitem>
|
||||
<term>#GtkCheckButton</term>
|
||||
<listitem><para>another way of presenting a toggle option.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkCheckMenuItem</term>
|
||||
<listitem><para>a #GtkToggleButton as a menu item.</para></listitem>
|
||||
<term>#GtkCheckMenuItem</term>
|
||||
<listitem><para>a #GtkToggleButton as a menu item.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
|
||||
@ -2,21 +2,48 @@
|
||||
gtktoggletoolbutton
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
A #GtkToolItem containing a toggle button.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A #GtkToggleToolButton is a #GtkToolItem that contains a toggle
|
||||
button.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Use gtk_toggle_tool_button_new() to create a new
|
||||
#GtkToggleToolButton. Use gtk_toggle_tool_button_new_from_stock() to
|
||||
create a new #GtkToggleToolButton containing a stock item.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
<para>
|
||||
<varlistentry>
|
||||
<term>#GtkToolbar</term>
|
||||
<listitem><para>The toolbar widget</para></listitem>
|
||||
<term>#GtkToolButton</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parent class of #GtkToggleToolButton. The properties
|
||||
"label_widget", "label", "icon_widget", and "stock_id" on
|
||||
#GtkToolButton determine the label and icon used on
|
||||
#GtkToggleToolButton<!-- -->s.
|
||||
</para>
|
||||
</listitem>
|
||||
<term>#GtkSeparatorToolItem</term>
|
||||
<listitem>
|
||||
<para>A subclass of #GtkToolItem that separates groups of
|
||||
items on a toolbar.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkToggleToolButton ##### -->
|
||||
<para>
|
||||
|
||||
The #GtkToggleToolButton struct contains only private data and
|
||||
should only be accessed through the functions described below.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
@ -2,42 +2,41 @@
|
||||
GtkToolbar
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
create bars of buttons and other widgets.
|
||||
Create bars of buttons and other widgets.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A toolbar is created with a call to gtk_toolbar_new().
|
||||
</para>
|
||||
<para>
|
||||
Buttons with text and/or images are added with gtk_toolbar_append_item(), gtk_toolbar_prepend_item(), and gtk_toolbar_insert_item().
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
Any of #GtkToggleButton, #GtkRadioButton, or an arbitrary widget can be added to the toolbar with gtk_toolbar_append_element(), gtk_toolbar_prepend_element(), and gtk_toolbar_insert_element().
|
||||
</para>
|
||||
<para>
|
||||
Widgets can be visibly grouped by adding gaps between widgets using gtk_toolbar_append_space(), gtk_toolbar_prepend_space(), and gtk_toolbar_insert_space().
|
||||
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>#GtkToolTips</term>
|
||||
<listitem><para>Change the properties of a #GtkToolbar's #GtkTooltips.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkTipsQuery</term>
|
||||
<listitem><para>Make use of the private tips of toolbar elements.</para></listitem>
|
||||
<term>#GtkToolItem</term>
|
||||
<listitem><para>Base class of widgets that can be added to a toolbar.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkToolbar ##### -->
|
||||
<para>
|
||||
<structfield>num_children</structfield> is an integer specifying how many toolbar items the #GtkToolbar contains. <structfield>children</structfield> is a #GList of the child widgets of the toolbar.
|
||||
</para>
|
||||
<para>
|
||||
<structfield>orientation</structfield>
|
||||
The #GtkToolbar struct only contains private data and should only be
|
||||
accessed through the function described below.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
@ -2,21 +2,70 @@
|
||||
GtkToolButton
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
A #GtkToolItem subclass that displays buttons
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
#GtkToolButton<!-- -->s are #GtkToolItems containing buttons.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Use gtk_tool_button_new() to create a new #GtkToolButton. Use
|
||||
gtk_tool_button_new_with_stock() to create a #GtkToolButton
|
||||
containing a stock item.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The label of a #GtkToolButton is determined by the properties
|
||||
"label_widget", "label", and "stock_id". If "label_widget" is
|
||||
non-%NULL, then that widget is used as the label. Otherwise, if
|
||||
"label" is non-%NULL, that string is used as the label. Otherwise, if
|
||||
"stock_id" is non-%NULL, the label is determined by the stock
|
||||
item. Otherwise, the button does not have a label.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The icon of a #GtkToolButton is determined by the properties
|
||||
"icon_widget" and "stock_id". If "icon_widget" is non-%NULL, then
|
||||
that widget is used as the icon. Otherwise, if "stock_id" is
|
||||
non-%NULL, the icon is determined by the stock item. Otherwise,
|
||||
the button does not have a label.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkToolbar</term>
|
||||
<listitem><para>The toolbar widget</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkToggleToolButton</term>
|
||||
<listitem><para>A subclass of #GtkToolButton that displays toggle
|
||||
buttons on the toolbar</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkRadioToolButton</term>
|
||||
<listitem><para>A subclass of #GtkToolButton that displays radio
|
||||
buttons on the toolbar</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkSeparatorToolItem</term>
|
||||
<listitem><para>A subclass of #GtkToolItem that separates groups of
|
||||
items on a toolbar</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkToolButton ##### -->
|
||||
<para>
|
||||
|
||||
The #GtkToolButton struct contains only private. It should only be
|
||||
accessed with the function described below.
|
||||
</para>
|
||||
|
||||
|
||||
@ -99,7 +148,7 @@ GtkToolButton
|
||||
</para>
|
||||
|
||||
@button:
|
||||
@icon:
|
||||
@icon_widget:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_tool_button_get_icon_widget ##### -->
|
||||
|
||||
@ -2,21 +2,50 @@
|
||||
GtkToolItem
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
#GtkToolItem is the base class of widgets that can be added to
|
||||
#GtkToolbar.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
#GtkToolItem<!-- -->s are widgets that can appear on a toolbar. To
|
||||
create a toolbar item that contain something else than a button, use
|
||||
gtk_tool_item_new(). Use gtk_container_add() to add a child
|
||||
widget to the tool item.
|
||||
</para>
|
||||
<para>
|
||||
For toolbar items that contain buttons, see the #GtkToolButton,
|
||||
#GtkToggleToolButton and #GtkRadioToolButton classes.
|
||||
</para>
|
||||
See the #GtkToolbar class for a description of the toolbar widget.
|
||||
<para>
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkToolbar</term>
|
||||
<listitem><para>The toolbar widget</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkToolButton</term>
|
||||
<listitem><para>A subclass of #GtkToolItem that displays buttons on
|
||||
the toolbar</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkSeparatorToolItem</term>
|
||||
<listitem><para>A subclass of #GtkToolItem that separates groups of
|
||||
items on a toolbar</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkToolItem ##### -->
|
||||
<para>
|
||||
|
||||
The GtkToolItem struct contains only private data. It should only be
|
||||
accessed through the functions described below.
|
||||
</para>
|
||||
|
||||
|
||||
@ -135,7 +164,7 @@ GtkToolItem
|
||||
</para>
|
||||
|
||||
@toolitem:
|
||||
@visible_horizontal:
|
||||
@visible_vertical:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_tool_item_get_visible_vertical ##### -->
|
||||
@ -229,6 +258,11 @@ GtkToolItem
|
||||
|
||||
@toolitem: the object which received the signal.
|
||||
|
||||
<!-- ##### ARG GtkToolItem:is-important ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkToolItem:visible-horizontal ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user