| GTK+ Reference Manual | |||
|---|---|---|---|
| <<< Previous Page | Home | Up | Next Page >>> |
#include <gtk/gtk.h> struct GtkToggleButton; GtkWidget* gtk_toggle_button_new (void); GtkWidget* gtk_toggle_button_new_with_label (const gchar *label); void gtk_toggle_button_set_mode (GtkToggleButton *toggle_button, gboolean draw_indicator); #define gtk_toggle_button_set_state void gtk_toggle_button_toggled (GtkToggleButton *toggle_button); gboolean gtk_toggle_button_get_active (GtkToggleButton *toggle_button); void gtk_toggle_button_set_active (GtkToggleButton *toggle_button, gboolean is_active); |
GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----GtkButton +----GtkToggleButton |
A GtkToggleButton is a GtkButton which will remain 'pressed-in' when clicked. Clicking again will cause the toggle button to return to it's normal state.
A toggle button is created by calling either gtk_toggle_button_new() or gtk_toggle_button_new_with_label(). If using the former, it is advisable to pack a widget, (such as a GtkLabel and/or a GtkPixmap), into the toggle button's container. (See GtkButton for more information).
The state of a GtkToggleButton can be set specifically using gtk_toggle_button_set_active(), and retrieved using gtk_toggle_button_get_active().
To simply switch the state of a toggle button, use gtk_toggle_button_toggled.
Example 1. Creating two GtkToggleButton widgets.
void make_toggles(void) {
GtkWidget *dialog, *toggle1, *toggle2;
dialog = gtk_dialog_new();
toggle1 = gtk_toggle_button_new_with_label("Hi, i'm a toggle button.");
/* Makes this toggle button invisible */
gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle1), TRUE);
gtk_signal_connect (GTK_OBJECT (toggle1), "toggled",
GTK_SIGNAL_FUNC (output_state), NULL);
gtk_box_pack_start (GTK_BOX (GTK_DIALOG(dialog)->action_area),
toggle1, FALSE, FALSE, 2);
toggle2 = gtk_toggle_button_new_with_label("Hi, i'm another toggle button.");
gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle2), FALSE);
gtk_signal_connect (GTK_OBJECT (toggle2), "toggled",
GTK_SIGNAL_FUNC (output_state), NULL);
gtk_box_pack_start (GTK_BOX (GTK_DIALOG(dialog)->action_area),
toggle2, FALSE, FALSE, 2);
gtk_widget_show_all (dialog);
}
|
struct GtkToggleButton; |
The GtkToggleButton struct contains private data only, and should be manipulated using the functions below.
GtkWidget* gtk_toggle_button_new (void); |
Creates a new toggle button. A widget should be packed into the button, as in gtk_button_new().
| Returns : | a new toggle button. |
GtkWidget* gtk_toggle_button_new_with_label (const gchar *label); |
Creates a new toggle button with a text label.
| label : | a string containing the message to be placed in the toggle button. |
| Returns : | a new toggle button. |
void gtk_toggle_button_set_mode (GtkToggleButton *toggle_button, gboolean draw_indicator); |
Determines whether or not the toggle button is drawn on screen. The default mode is FALSE, which results in the button being displayed. To make the button invisible, set draw_indicator to TRUE.
| toggle_button : | a GtkToggleButton. |
| draw_indicator : | TRUE or FALSE. |
#define gtk_toggle_button_set_state gtk_toggle_button_set_active |
This is a deprecated macro, and is only maintained for compatability reasons.
void gtk_toggle_button_toggled (GtkToggleButton *toggle_button); |
Changes the state of the toggle button.
| toggle_button : | a GtkToggleButton. |
gboolean gtk_toggle_button_get_active (GtkToggleButton *toggle_button); |
Queries a GtkToggleButton and returns it's current state. Returns TRUE if the toggle button is pressed in and FALSE if it is raised.
| toggle_button : | a GtkToggleButton. |
| Returns : | a gboolean value. |
void gtk_toggle_button_set_active (GtkToggleButton *toggle_button, gboolean is_active); |
Sets the status of the toggle 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.
| toggle_button : | a GtkToggleButton. |
| is_active : | TRUE or FALSE. |
void user_function (GtkToggleButton *togglebutton, gpointer user_data); |
Should be connected if you wish to perform an action whenever the GtkToggleButton's state is changed.
| togglebutton : | the object which received the signal. |
| user_data : | user data set when the signal handler was connected. |
a more general button.
another way of presenting a toggle option.
a GtkToggleButton as a menu item.