Class Fox::FXButton
In: rdoc-sources/FXButton.rb
Parent: FXLabel

A button provides a push button, with optional icon and/or text label. When pressed, the button widget sends a SEL_COMMAND to its target. Passing the BUTTON_TOOLBAR style option gives buttons a "flat" look, and causes the edge of the button to be raised when the cursor moves over it. Passing BUTTON_DEFAULT allows the button to become the default button in a dialog, when the focus moves to it. The default widget in a dialog is the widget which will accept the Return key when it is pressed. The BUTTON_INITIAL flag makes the button the default widget when the focus moves to a widget which can not itself be a default widget. There should be only a single button in the dialog which is the initial default; typically this is the OK or Close button. The option BUTTON_AUTOGRAY (BUTTON_AUTOHIDE) causes the button to be grayed out (hidden) if its handler does not respond to the SEL_UPDATE message. This is useful when messages are delegated, for example when using a multiple document interface, where the ultimate destination of a message can be changed.

Events

The following messages are sent by FXButton to its target:

SEL_KEYPRESS:sent when a key goes down; the message data is an FXEvent instance.
SEL_KEYRELEASE:sent when a key goes up; the message data is an FXEvent instance.
SEL_LEFTBUTTONPRESS:sent when the left mouse button goes down; the message data is an FXEvent instance.
SEL_LEFTBUTTONRELEASE:sent when the left mouse button goes up; the message data is an FXEvent instance.
SEL_COMMAND:sent when the button is clicked.

Button state bits

STATE_UP:Button is up
STATE_DOWN:Button is down
STATE_ENGAGED:Button is engaged
STATE_UNCHECKED:Same as STATE_UP (used for check buttons or radio buttons)
STATE_CHECKED:Same as STATE_ENGAGED (used for check buttons or radio buttons)

Button flags

BUTTON_AUTOGRAY:Automatically gray out when not updated
BUTTON_AUTOHIDE:Automatically hide button when not updated
BUTTON_TOOLBAR:Toolbar style button [flat look]
BUTTON_DEFAULT:May become default button when receiving focus
BUTTON_INITIAL:This button is the initial default button
BUTTON_NORMAL:Default button flags (FRAME_RAISED|FRAME_THICK|JUSTIFY_NORMAL|ICON_BEFORE_TEXT)

Methods

new  

Attributes

buttonStyle  [RW]  Button style flags (some combination of BUTTON_AUTOGRAY, BUTTON_AUTOHIDE, etc.) [Integer]
state  [RW]  Button state (one of STATE_UP, STATE_DOWN, etc.) [Integer]

Public Class methods

[Validate]