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

GFC::Gtk::CheckMenuItem Class Reference

A GtkCheckMenuItem C++ wrapper class. More...

#include <gfc/gtk/checkmenuitem.hh>

Inheritance diagram for GFC::Gtk::CheckMenuItem:

GFC::Gtk::MenuItem GFC::Gtk::Item 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::RadioMenuItem List of all members.

Signal Prototypes

Public Member Functions

Constructors
Accessors
Methods
Signal Proxies

Protected Member Functions

Constructors

Detailed Description

A GtkCheckMenuItem C++ wrapper class.

A CheckMenuItem is a menu item that maintains the state of a bool value in addition to a MenuItem's usual role in activating application code. A check box indicating the state of the bool value is displayed at the left side of the MenuItem. Activating the MenuItem toggles the value.


Constructor & Destructor Documentation

GFC::Gtk::CheckMenuItem::CheckMenuItem GtkCheckMenuItem *  check_menu_item,
bool  owns_reference = false
[explicit, protected]
 

Construct a new CheckMenuItem from an existing GtkCheckMenuItem.

Parameters:
check_menu_item A pointer to a GtkCheckMenuItem.
owns_reference Set false if the initial reference count is floating, set true if it's not.

The check_menu_item can be a newly created GtkCheckMenuItem or an existing GtkCheckMenuItem. (see G::Object::Object).

GFC::Gtk::CheckMenuItem::CheckMenuItem const String label,
bool  use_underline = false
[explicit]
 

Construct a new CheckMenuItem with a Label to the right of it.

Parameters:
label The text for the menu item.
use_underline true if the label contains an underscore, indicating a mnemonic.

If use_underline is true an underscore in label indicates that the next character is the mnemonic accelerator for the menu item.


Member Function Documentation

bool GFC::Gtk::CheckMenuItem::get_draw_as_radio  )  const
 

Determines whether the check menu item looks like a Gtk::RadioMenuItem.

Returns:
true if the check menu item looks like a Gtk::RadioMenuItem.

void GFC::Gtk::CheckMenuItem::set_active bool  is_active  ) 
 

Sets the active state of the menu item's check box.

Parameters:
is_active A bool value indicating whether the check box is active.

void GFC::Gtk::CheckMenuItem::set_draw_as_radio bool  draw_as_radio  ) 
 

Sets whether check_menu_item is drawn like a Gtk::RadioMenuItem.

Parameters:
draw_as_radio Set true to draw the check menu item like a Gtk::RadioMenuItem.

void GFC::Gtk::CheckMenuItem::set_inconsistent bool  setting  ) 
 

Display the check in an "in between" state.

Parameters:
setting true to display an "inconsistent" third state check.

If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a boolean setting, and the current values in that range are inconsistent, you may want to display the check in an "in between" state. This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user explicitly selects a setting. This has to be done manually, set_inconsistent() only affects visual appearance, it doesn't affect the semantics of the widget.


Member Data Documentation

const ToggledSignalType GFC::Gtk::CheckMenuItem::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:38 2004 for GFC-UI by doxygen 1.3.8