GtkToggleToolButton
GtkToggleToolButton — A GtkToolItem containing a toggle button
Functions
Properties
gboolean | active | Read / Write |
Signals
void | toggled | Run First |
Types and Values
struct | GtkToggleToolButton |
struct | GtkToggleToolButtonClass |
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkToolItem ╰── GtkToolButton ╰── GtkToggleToolButton ╰── GtkRadioToolButton
Implemented Interfaces
GtkToggleToolButton implements AtkImplementorIface, GtkBuildable, GtkActivatable and GtkActionable.
Includes
#include <gtk/gtk.h>
Description
A GtkToggleToolButton is a GtkToolItem that contains a toggle button.
Use gtk_toggle_tool_button_new()
to create a new GtkToggleToolButton.
CSS nodes
GtkToggleToolButton has a single CSS node with name togglebutton.
Functions
gtk_toggle_tool_button_new ()
GtkToolItem *
gtk_toggle_tool_button_new (void
);
Returns a new GtkToggleToolButton
Returns
a newly created GtkToggleToolButton
Since: 2.4
gtk_toggle_tool_button_new_from_stock ()
GtkToolItem *
gtk_toggle_tool_button_new_from_stock (const gchar *stock_id
);
gtk_toggle_tool_button_new_from_stock
has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_toggle_tool_button_new()
instead.
Creates a new GtkToggleToolButton containing the image and text from a stock item. Some stock ids have preprocessor macros like GTK_STOCK_OK and GTK_STOCK_APPLY.
It is an error if stock_id
is not a name of a stock item.
Parameters
stock_id | the name of the stock item |
Returns
A new GtkToggleToolButton
Since: 2.4
gtk_toggle_tool_button_set_active ()
void gtk_toggle_tool_button_set_active (GtkToggleToolButton *button
,gboolean is_active
);
Sets the status of the toggle tool button. Set to TRUE
if you want the GtkToggleButton to be “pressed in”, and FALSE
to raise it. This action causes the toggled signal to be emitted.
Parameters
button | ||
is_active | whether |
Since: 2.4
gtk_toggle_tool_button_get_active ()
gboolean
gtk_toggle_tool_button_get_active (GtkToggleToolButton *button
);
Queries a GtkToggleToolButton and returns its current state. Returns TRUE
if the toggle button is pressed in and FALSE
if it is raised.
Parameters
button |
Returns
TRUE
if the toggle tool button is pressed in, FALSE
if not
Since: 2.4
Types and Values
struct GtkToggleToolButton
struct GtkToggleToolButton;
struct GtkToggleToolButtonClass
struct GtkToggleToolButtonClass { GtkToolButtonClass parent_class; /* signal */ void (* toggled) (GtkToggleToolButton *button); };
Members
| Signal emitted whenever the toggle tool button changes state. |
Property Details
The “active”
property
“active” gboolean
If the toggle tool button should be pressed in.
Owner: GtkToggleToolButton
Flags: Read / Write
Default value: FALSE
Since: 2.8
Signal Details
The “toggled”
signal
void user_function (GtkToggleToolButton *toggle_tool_button, gpointer user_data)
Emitted whenever the toggle tool button changes state.
Parameters
toggle_tool_button | the object that emitted the signal | |
user_data | user data set when the signal handler was connected. |
Flags: Run First
See Also
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkToggleToolButton.html