module Fox
#
# The toggle button provides a two-state button, which toggles between the
# on and the off state each time it is pressed. For each state, the toggle
# button has a unique icon and text label.
#
# === Events
#
# The following messages are sent by FXToggleButton to its target:
#
# +SEL_COMMAND+:: sent when the toggle button is pressed.
# +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.
#
# === Toggle button flags
#
# +TOGGLEBUTTON_AUTOGRAY+:: Automatically gray out when not updated
# +TOGGLEBUTTON_AUTOHIDE+:: Automatically hide toggle button when not updated
# +TOGGLEBUTTON_TOOLBAR+:: Toolbar style toggle button [flat look]
# +TOGGLEBUTTON_KEEPSTATE+:: Draw button according to state
# +TOGGLEBUTTON_NORMAL+:: FRAME_RAISED|FRAME_THICK|JUSTIFY_NORMAL|ICON_BEFORE_TEXT
#
class FXToggleButton < FXLabel
# Alternate text, shown when toggled [String]
attr_accessor :altText
# Alternate icon, shown when toggled [FXIcon]
attr_accessor :altIcon
# Toggled state [+true+ or +false+]
attr_accessor :state
# Alternate status line help text, shown when toggled [String]
attr_accessor :altHelpText
# Alternate tool tip message, shown when toggled [String]
attr_accessor :altTipText
# Toggle button style [Integer]
attr_accessor :toggleStyle
#
# Return an initialized FXToggleButton instance.
#
# ==== Parameters:
#
# +p+:: the parent window for this toggle button [FXComposite]
# text1:: the text for this toggle button's first state [String]
# text2:: the text for this toggle button's second state [String]
# icon1:: the icon, if any, for this toggle button's first state [FXIcon]
# icon2:: the icon, if any, for this toggle button's second state [FXIcon]
# +tgt+:: the message target, if any, for this toggle button [FXObject]
# +sel+:: the message identifier for this toggle button [Integer]
# +opts+:: toggle button options [Integer]
# +x+:: initial x-position [Integer]
# +y+:: initial y-position [Integer]
# +w+:: initial width [Integer]
# +h+:: initial height [Integer]
# +pl+:: internal padding on the left side, in pixels [Integer]
# +pr+:: internal padding on the right side, in pixels [Integer]
# +pt+:: internal padding on the top side, in pixels [Integer]
# +pb+:: internal padding on the bottom side, in pixels [Integer]
#
def initialize(p, text1, text2, icon1=nil, icon2=nil, tgt=nil, sel=0, opts=TOGGLEBUTTON_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theToggleButton
end
end
end