Class: Fox::FXTriStateButton

Inherits:
FXToggleButton show all
Defined in:
rdoc-sources/FXTriStateButton.rb

Overview

The tri-state button provides a three-state button, which toggles between the on and the off state each time it is pressed. Programmatically, it may also be switched into the MAYBE state. The MAYBE state is useful to signify an “unknown” or “indeterminate” state in the application data.

Instance Attribute Summary collapse

Attributes inherited from FXToggleButton

#altHelpText, #altIcon, #altText, #altTipText, #state, #toggleStyle

Attributes inherited from FXLabel

#font, #helpText, #icon, #iconPosition, #justify, #text, #textColor, #tipText

Attributes inherited from FXFrame

#baseColor, #borderColor, #borderWidth, #frameStyle, #hiliteColor, #padBottom, #padLeft, #padRight, #padTop, #shadowColor

Attributes inherited from FXWindow

#accelTable, #backColor, #defaultCursor, #dragCursor, #first, #focus, #key, #last, #layoutHints, #next, #numChildren, #owner, #parent, #prev, #root, #selector, #shell, #target, #x, #y

Attributes inherited from FXDrawable

#height, #visual, #width

Attributes inherited from FXId

#app, #userData, #xid

Instance Method Summary collapse

Methods inherited from FXLabel

#to_s

Methods inherited from FXWindow

#acceptDrop, #acquireClipboard, #acquireSelection, #active?, #addHotKey, after?, #after?, before?, #before?, #beginDrag, #canFocus?, #changeFocus, #childAtIndex, #childOf?, #children, #clearDragRectangle, #clearShape, colorType, colorTypeName, commonAncestor, #composeContext, #composite?, #contains?, #containsChild?, #create, #createComposeContext, #cursorPosition, #default?, #defaultHeight, #defaultWidth, deleteType, deleteTypeName, #destroy, #destroyComposeContext, #detach, #didAccept, #disable, #doesSaveUnder?, #dragging?, #dropDisable, #dropEnable, #dropEnabled?, #dropFinished, #dropTarget?, #each_child, #each_child_recursive, #enable, #enabled?, #endDrag, #forceRefresh, #getChildAt, #getDNDData, #getHeightForWidth, #getWidthForHeight, #grab, #grabKeyboard, #grabbed?, #grabbedKeyboard?, #handleDrag, #hasClipboard?, #hasFocus?, #hasSelection?, #height, #height=, #hide, imageType, #inFocusChain?, #indexOfChild, #initial?, #inquireDNDAction, #inquireDNDTypes, #killFocus, #layout, #linkAfter, #linkBefore, #lower, #move, octetType, octetTypeName, #offeredDNDType?, #position, #raiseWindow, #recalc, #releaseClipboard, #releaseSelection, #remHotKey, #removeChild, #repaint, #reparent, #resize, #scroll, #setCursorPosition, #setDNDData, #setDefault, #setDragRectangle, #setFocus, #setInitial, #setShape, #shell?, #show, #shown?, stringType, textType, textTypeName, #tr, #translateCoordinatesFrom, #translateCoordinatesTo, #underCursor?, #ungrab, #ungrabKeyboard, #update, urilistType, urilistTypeName, utf16Type, utf16TypeName, utf8Type, utf8TypeName, #visible=, #width, #width=

Methods included from Responder2

#connect

Methods inherited from FXDrawable

#resize

Methods inherited from FXId

#create, #created?, #destroy, #detach, #runOnUiThread

Methods inherited from FXObject

#bind, #handle, #load, #save, subclasses

Constructor Details

#initialize(p, text1, text2, text3, icon1 = nil, icon2 = nil, icon3 = nil, target = nil, selector = 0, opts = TOGGLEBUTTON_NORMAL, x = 0, y = 0, width = 0, height = 0, padLeft = DEFAULT_PAD, padRight = DEFAULT_PAD, padTop = DEFAULT_PAD, padBottom = DEFAULT_PAD) ⇒ FXTriStateButton

Return an initialized FXTriStateButton instance.

Parameters:

p

the parent window for this tri-state button Fox::FXComposite

text1

the text for this tri-state button's first state [String]

text2

the text for this tri-state button's second state [String]

text3

the text for this tri-state button's third state [String]

icon1

the icon, if any, for this tri-state button's first state Fox::FXIcon

icon2

the icon, if any, for this tri-state button's second state Fox::FXIcon

icon3

the icon, if any, for this tri-state button's third state Fox::FXIcon

target

the message target, if any, for this tri-state button Fox::FXObject

selector

the message identifier for this tri-state button [Integer]

opts

tri-state button options [Integer]

x

initial x-position [Integer]

y

initial y-position [Integer]

width

initial width [Integer]

height

initial height [Integer]

padLeft

internal padding on the left side, in pixels [Integer]

padRight

internal padding on the right side, in pixels [Integer]

padTop

internal padding on the top side, in pixels [Integer]

padBottom

internal padding on the bottom side, in pixels [Integer]


46
47
# File 'rdoc-sources/FXTriStateButton.rb', line 46

def initialize(p, text1, text2, text3, icon1=nil, icon2=nil, icon3=nil, target=nil, selector=0, opts=TOGGLEBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTriStateButton
end

Instance Attribute Details

#maybeHelpTextObject

Maybe status line help text, shown when toggled [String]


17
18
19
# File 'rdoc-sources/FXTriStateButton.rb', line 17

def maybeHelpText
  @maybeHelpText
end

#maybeIconObject

Maybe icon, shown when toggled Fox::FXIcon


14
15
16
# File 'rdoc-sources/FXTriStateButton.rb', line 14

def maybeIcon
  @maybeIcon
end

#maybeTextObject

Maybe text, shown when toggled [String]


11
12
13
# File 'rdoc-sources/FXTriStateButton.rb', line 11

def maybeText
  @maybeText
end

#maybeTipTextObject

Maybe tool tip message, shown when toggled [String]


20
21
22
# File 'rdoc-sources/FXTriStateButton.rb', line 20

def maybeTipText
  @maybeTipText
end