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

GFC::Gtk::AccelKey Class Reference

An accelerator key value, modifier and flag class. More...

#include <gfc/gtk/accelkey.hh>

List of all members.

Public Member Functions

Constructors
Accessors
Methods

Detailed Description

An accelerator key value, modifier and flag class.

AccelKey encapsulates an accelerator key, its accelerator flags (for configuring the accelerator) and its modifier flags (the modifier combination of the accelerator).


Constructor & Destructor Documentation

GFC::Gtk::AccelKey::AccelKey const String accelerator,
AccelFlagsField  accel_flags = Gtk::ACCEL_VISIBLE
 

Construct an AccelKey from a string representing an accelerator.

Parameters:
accelerator A string representing an accelerator.
accel_flags A flag mask to configure this accelerator.

Parses a string representing an accelerator. The format looks like "\<Control\>a" or "\<Shift\>\<Alt\>F1" or "\<Release\>z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "\<Ctl\>" and "\<Ctrl\>". If the parse fails, accelerator and its modifiers will be set to 0 (zero).

GFC::Gtk::AccelKey::AccelKey unsigned int  accel_key,
Gdk::ModifierTypeField  accel_mods,
AccelFlagsField  accel_flags = Gtk::ACCEL_VISIBLE
 

Construct an AccelKey with the specified key, modifier and flag values.

Parameters:
accel_key Key value of the accelerator.
accel_mods Modifier combination of the accelerator.
accel_flags A flag mask to configure this accelerator.


Member Function Documentation

void GFC::Gtk::AccelKey::set unsigned int  accel_key,
Gdk::ModifierTypeField  accel_mods,
AccelFlagsField  accel_flags = Gtk::ACCEL_VISIBLE
 

Set the accelerator key, modifier and flag values.

Parameters:
accel_key Key value of the accelerator.
accel_mods Modifier combination of the accelerator.
accel_flags A flag mask to configure this accelerator.

void GFC::Gtk::AccelKey::set const String accelerator,
AccelFlagsField  accel_flags = Gtk::ACCEL_VISIBLE
 

Set the accelerator values from a string representation of an accelerator.

Parameters:
accelerator A string representing an accelerator.
accel_flags A flag mask to configure this accelerator.

Parses a string representing an accelerator. The format looks like "\<Control\>a" or "\<Shift\>\<Alt\>F1" or "\<Release\>z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "\<Ctl\>" and "\<Ctrl\>". If the parse fails, accelerator and its modifiers will be set to 0 (zero).


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