Class: Fox::FXMenuCheck

Inherits:
FXMenuCommand show all
Defined in:
rdoc-sources/FXMenuCheck.rb,
lib/fox16/core.rb

Overview

The FXMenuCheck widget is used to change a state in the application from a menu. Menu checks may reflect the state of the application by graying out, becoming hidden, or by a check mark. When activated, a menu check sends a SEL_COMMAND message to its target; the message data contains the new state (one of TRUE, FALSE or MAYBE).

Events

The following messages are sent by FXMenuCheck to its target:

SEL_COMMAND

sent when the command is activated

Instance Attribute Summary collapse

Attributes inherited from FXMenuCommand

#accelText

Attributes inherited from FXMenuCaption

#font, #helpText, #hiliteColor, #icon, #selBackColor, #selTextColor, #shadowColor, #text, #textColor, #tipText

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 FXMenuCaption

#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, text, target = nil, selector = 0, opts = 0) ⇒ FXMenuCheck

Construct a menu check



26
27
 
# File 'rdoc-sources/FXMenuCheck.rb', line 26

def initialize(p, text, target=nil, selector=0, opts=0) # :yields: theMenuCheck
end

Instance Attribute Details

#boxColor ⇒ Object

Box background color Fox::FXColor



21
22
23
 
# File 'rdoc-sources/FXMenuCheck.rb', line 21

def boxColor
  @boxColor
end

#check ⇒ Object

Check state, one of TRUE, FALSE or MAYBE



18
19
20
 
# File 'rdoc-sources/FXMenuCheck.rb', line 18

def check
  @check
end

Instance Method Details

#checked? ⇒ Boolean

Return true if this menu check button is in the checked state.

Returns:

  • (Boolean) 


540
541
542
 
# File 'lib/fox16/core.rb', line 540

def checked?
  self.checkState == TRUE
end

#maybe? ⇒ Boolean

Return true if this menu check button is in the indeterminate, or “maybe”, state.

Returns:

  • (Boolean) 


550
551
552
 
# File 'lib/fox16/core.rb', line 550

def maybe?
  self.checkState == MAYBE
end

#unchecked? ⇒ Boolean

Return true if this menu check button is in the unchecked state.

Returns:

  • (Boolean) 


545
546
547
 
# File 'lib/fox16/core.rb', line 545

def unchecked?
  self.checkState == FALSE
end