Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::ToggleToolButton Class Reference

A GtkToggleToolButton C++ wrapper class. More...

#include <xfc/gtk/toggletoolbutton.hh>

Inheritance diagram for Xfc::Gtk::ToggleToolButton:

Xfc::Gtk::ToolButton Xfc::Gtk::ToolItem Xfc::Gtk::Bin Xfc::Gtk::Container Xfc::Gtk::Widget Xfc::Gtk::Object Xfc::Atk::Implementor Xfc::G::Object Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::G::TypeInstance Xfc::Trackable Xfc::Trackable Xfc::Gtk::RadioToolButton List of all members.

Signal Prototypes

Public Member Functions

Accessors
Methods
Signal Proxies

Detailed Description

A GtkToggleToolButton C++ wrapper class.

A ToggleToolButton is a ToolItem that contains a toggle button.

See also: the ToolItems HOWTO.


Constructor & Destructor Documentation

Xfc::Gtk::ToggleToolButton::ToggleToolButton ( GtkToggleToolButton *  button,
bool  owns_reference = false 
) [explicit, protected]

Construct a new ToggleToolButton from an existing GtkToggleToolButton.

Parameters:
button A pointer to a GtkToggleToolButton.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The button can be a newly created GtkToggleToolButton or an existing GtkToggleToolButton (see G::Object::Object).

Xfc::Gtk::ToggleToolButton::ToggleToolButton ( const StockId stock_id  ) 

Constructs a new toggle tool button containing the image and text from a stock item.

Parameters:
stock_id The ID of the stock item (see set_stock_id()).
It is an error if stock_id is not a name of a stock item.

Xfc::Gtk::ToggleToolButton::ToggleToolButton ( GtkToggleToolButton *  button,
bool  owns_reference = false 
) [explicit, protected]

Construct a new ToggleToolButton from an existing GtkToggleToolButton.

Parameters:
button A pointer to a GtkToggleToolButton.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The button can be a newly created GtkToggleToolButton or an existing GtkToggleToolButton (see G::Object::Object).

Xfc::Gtk::ToggleToolButton::ToggleToolButton ( const StockId stock_id  ) 

Constructs a new toggle tool button containing the image and text from a stock item.

Parameters:
stock_id The ID of the stock item (see set_stock_id()).
It is an error if stock_id is not a name of a stock item.


Member Function Documentation

bool Xfc::Gtk::ToggleToolButton::get_active (  )  const

Queries a toggle tool button and returns its current state.

Returns:
true if the toggle button is pressed in and false if it is raised.

void Xfc::Gtk::ToggleToolButton::set_active ( bool  is_active  ) 

Sets the status of the toggle tool button.

Parameters:
is_active Whether the button should be active or not.
Set to true if you want the toggle tool button to be 'pressed in', and false to raise it. This action causes the toggled signal to be emitted.


Member Data Documentation

const ToggledSignalType Xfc::Gtk::ToggleToolButton::toggled_signal [static, protected]

Toggled signal (see signal_toggled()).

Calls a slot with the signature:

< void function();
<


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3