Blame docs/reference/gtk/html/GtkToggleButton.html

Packit Service fb6fa5
Packit Service fb6fa5
<html>
Packit Service fb6fa5
<head>
Packit Service fb6fa5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service fb6fa5
<title>GtkToggleButton: GTK+ 2 Reference Manual</title>
Packit Service fb6fa5
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit Service fb6fa5
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
Packit Service fb6fa5
<link rel="up" href="ButtonWidgets.html" title="Buttons and Toggles">
Packit Service fb6fa5
<link rel="prev" href="GtkRadioButton.html" title="GtkRadioButton">
Packit Service fb6fa5
<link rel="next" href="GtkLinkButton.html" title="GtkLinkButton">
Packit Service fb6fa5
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit Service fb6fa5
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service fb6fa5
</head>
Packit Service fb6fa5
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Top  | 
Packit Service fb6fa5
                  Description  | 
Packit Service fb6fa5
                  Object Hierarchy  | 
Packit Service fb6fa5
                  Implemented Interfaces  | 
Packit Service fb6fa5
                  Properties  | 
Packit Service fb6fa5
                  Signals
Packit Service fb6fa5
Packit Service fb6fa5
Home
Packit Service fb6fa5
Up
Packit Service fb6fa5
Prev
Packit Service fb6fa5
Next
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

GtkToggleButton

Packit Service fb6fa5

GtkToggleButton

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Functions

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
GtkWidget *
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_new ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
GtkWidget *
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_new_with_label ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
GtkWidget *
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_new_with_mnemonic ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_set_mode ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gboolean
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_get_mode ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_toggled ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gboolean
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_get_active ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_set_active ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gboolean
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_get_inconsistent ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gtk_toggle_button_set_inconsistent ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Properties

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gboolean
Packit Service fb6fa5
active
Packit Service fb6fa5
Read / Write
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gboolean
Packit Service fb6fa5
draw-indicator
Packit Service fb6fa5
Read / Write
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gboolean
Packit Service fb6fa5
inconsistent
Packit Service fb6fa5
Read / Write
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Signals

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
toggled
Packit Service fb6fa5
Run First
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Types and Values

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
struct
Packit Service fb6fa5
GtkToggleButton
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
#define
Packit Service fb6fa5
gtk_toggle_button_set_state
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Object Hierarchy

Packit Service fb6fa5
    GObject
Packit Service fb6fa5
    ╰── GInitiallyUnowned
Packit Service fb6fa5
        ╰── GtkObject
Packit Service fb6fa5
            ╰── GtkWidget
Packit Service fb6fa5
                ╰── GtkContainer
Packit Service fb6fa5
                    ╰── GtkBin
Packit Service fb6fa5
                        ╰── GtkButton
Packit Service fb6fa5
                            ╰── GtkToggleButton
Packit Service fb6fa5
                                ╰── GtkCheckButton
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Implemented Interfaces

Packit Service fb6fa5

Packit Service fb6fa5
GtkToggleButton implements
Packit Service fb6fa5
 AtkImplementorIface,  GtkBuildable and  GtkActivatable.

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Includes

Packit Service fb6fa5
#include <gtk/gtk.h>
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Description

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Functions

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_new ()

Packit Service fb6fa5
GtkWidget *
Packit Service fb6fa5
gtk_toggle_button_new (void);
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_new_with_label ()

Packit Service fb6fa5
GtkWidget *
Packit Service fb6fa5
gtk_toggle_button_new_with_label (const gchar *label);
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_new_with_mnemonic ()

Packit Service fb6fa5
GtkWidget *
Packit Service fb6fa5
gtk_toggle_button_new_with_mnemonic (const gchar *label);
Packit Service fb6fa5

Creates a new GtkToggleButton containing a label. The label

Packit Service fb6fa5
will be created using gtk_label_new_with_mnemonic(), so underscores
Packit Service fb6fa5
in label
Packit Service fb6fa5
 indicate the mnemonic for the button.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

label

Packit Service fb6fa5

the text of the button, with an underscore in front of the

Packit Service fb6fa5
mnemonic character

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

returns

Packit Service fb6fa5

a new GtkToggleButton

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_set_mode ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gtk_toggle_button_set_mode (GtkToggleButton *toggle_button,
Packit Service fb6fa5
                            gboolean draw_indicator);
Packit Service fb6fa5

Sets whether the button is displayed as a separate indicator and label.

Packit Service fb6fa5
You can call this function on a checkbutton or a radiobutton with
Packit Service fb6fa5
draw_indicator
Packit Service fb6fa5
 = FALSE to make the button look like a normal button

Packit Service fb6fa5

This function only affects instances of classes like GtkCheckButton

Packit Service fb6fa5
and GtkRadioButton that derive from GtkToggleButton,
Packit Service fb6fa5
not instances of GtkToggleButton itself.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

toggle_button

Packit Service fb6fa5

a GtkToggleButton

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

draw_indicator

Packit Service fb6fa5

if TRUE, draw the button as a separate indicator

Packit Service fb6fa5
and label; if FALSE, draw the button like a normal button

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_get_mode ()

Packit Service fb6fa5
gboolean
Packit Service fb6fa5
gtk_toggle_button_get_mode (GtkToggleButton *toggle_button);
Packit Service fb6fa5

Retrieves whether the button is displayed as a separate indicator

Packit Service fb6fa5
and label. See gtk_toggle_button_set_mode().

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

toggle_button

Packit Service fb6fa5

a GtkToggleButton

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Returns

Packit Service fb6fa5

TRUE if the togglebutton is drawn as a separate indicator

Packit Service fb6fa5
and label.

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_toggled ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gtk_toggle_button_toggled (GtkToggleButton *toggle_button);
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_get_active ()

Packit Service fb6fa5
gboolean
Packit Service fb6fa5
gtk_toggle_button_get_active (GtkToggleButton *toggle_button);
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_set_active ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gtk_toggle_button_set_active (GtkToggleButton *toggle_button,
Packit Service fb6fa5
                              gboolean is_active);
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_get_inconsistent ()

Packit Service fb6fa5
gboolean
Packit Service fb6fa5
gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button);
Packit Service fb6fa5

Gets the value set by gtk_toggle_button_set_inconsistent().

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

toggle_button

Packit Service fb6fa5

a GtkToggleButton

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Returns

Packit Service fb6fa5

TRUE if the button is displayed as inconsistent, FALSE otherwise

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_set_inconsistent ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button,
Packit Service fb6fa5
                                    gboolean setting);
Packit Service fb6fa5

If the user has selected a range of elements (such as some text or

Packit Service fb6fa5
spreadsheet cells) that are affected by a toggle button, and the
Packit Service fb6fa5
current values in that range are inconsistent, you may want to
Packit Service fb6fa5
display the toggle in an "in between" state. This function turns on
Packit Service fb6fa5
"in between" display.  Normally you would turn off the inconsistent
Packit Service fb6fa5
state again if the user toggles the toggle button. This has to be
Packit Service fb6fa5
done manually, gtk_toggle_button_set_inconsistent() only affects
Packit Service fb6fa5
visual appearance, it doesn't affect the semantics of the button.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

toggle_button

Packit Service fb6fa5

a GtkToggleButton

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

setting

Packit Service fb6fa5

TRUE if state is inconsistent

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Types and Values

Packit Service fb6fa5
Packit Service fb6fa5

struct GtkToggleButton

Packit Service fb6fa5
struct GtkToggleButton;
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_set_state

Packit Service fb6fa5
#define gtk_toggle_button_set_state		gtk_toggle_button_set_active
Packit Service fb6fa5
Packit Service fb6fa5

gtk_toggle_button_set_state is deprecated and should not be used in newly-written code.

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Property Details

Packit Service fb6fa5
Packit Service fb6fa5

The “active” property

Packit Service fb6fa5
  “active”                   gboolean
Packit Service fb6fa5

If the toggle button should be pressed in or not.

Packit Service fb6fa5

Flags: Read / Write

Packit Service fb6fa5

Default value: FALSE

Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

The “draw-indicator” property

Packit Service fb6fa5
  “draw-indicator”           gboolean
Packit Service fb6fa5

If the toggle part of the button is displayed.

Packit Service fb6fa5

Flags: Read / Write

Packit Service fb6fa5

Default value: FALSE

Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

The “inconsistent” property

Packit Service fb6fa5
  “inconsistent”             gboolean
Packit Service fb6fa5

If the toggle button is in an "in between" state.

Packit Service fb6fa5

Flags: Read / Write

Packit Service fb6fa5

Default value: FALSE

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Signal Details

Packit Service fb6fa5
Packit Service fb6fa5

The “toggled” signal

Packit Service fb6fa5
void
Packit Service fb6fa5
user_function (GtkToggleButton *togglebutton,
Packit Service fb6fa5
               gpointer         user_data)
Packit Service fb6fa5

Flags: Run First

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Generated by GTK-Doc V1.26.1
Packit Service fb6fa5
</body>
Packit Service fb6fa5
</html>