GFC Logo GFC Title Logo
Reference Manual
Main Page  |  Namespace List  |  Alphabetical List  |  Class List  |  File List

GFC::Gtk::ToggleToolButton Class Reference

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

#include <gfc/gtk/toggletoolbutton.hh>

Inheritance diagram for GFC::Gtk::ToggleToolButton:

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

Signal Prototypes

Public Member Functions

Constructors
Accessors
Methods
Signal Proxies

Protected Member Functions

Constructors

Detailed Description

A GtkToggleToolButton C++ wrapper class.

A ToggleToolButton is a ToolItem that contains a toggle button.


Constructor & Destructor Documentation

GFC::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).

GFC::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 GFC::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 GFC::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 GFC::Gtk::ToggleToolButton::toggled_signal [static, protected]
 

Toggled signal (see sig_toggled()).

Calls a slot with the signature:

             void function();


The documentation for this class was generated from the following file:
Generated on Tue Aug 24 00:34:43 2004 for GFC-UI by doxygen 1.3.8