Class: Fox::FXMenuCaption

Inherits:
FXWindow show all
Defined in:
rdoc-sources/FXMenuCaption.rb

Overview

The menu caption is a widget which can be used as a caption above a number of menu commands in a menu.

Menu caption options

MENU_AUTOGRAY

Automatically gray out when not updated

MENU_AUTOHIDE

Automatically hide button when not updated

Direct Known Subclasses

FXMenuCascade, FXMenuCommand, FXMenuTitle

Instance Attribute Summary collapse

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 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(parent, text, icon = nil, opts = 0) ⇒ FXMenuCaption

Construct a new menu caption


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

def initialize(parent, text, icon=nil, opts=0) # :yields: theMenuCaption
end

Instance Attribute Details

#fontObject

The text font Fox::FXFont


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

def font
  @font
end

#helpTextObject

Status line help text for this menu [String]


38
39
40
# File 'rdoc-sources/FXMenuCaption.rb', line 38

def helpText
  @helpText
end

#hiliteColorObject

Highlight color Fox::FXColor


32
33
34
# File 'rdoc-sources/FXMenuCaption.rb', line 32

def hiliteColor
  @hiliteColor
end

#iconObject

The icon for this menu Fox::FXIcon


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

def icon
  @icon
end

#selBackColorObject

Selection background color Fox::FXColor


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

def selBackColor
  @selBackColor
end

#selTextColorObject

Selection text color Fox::FXColor


29
30
31
# File 'rdoc-sources/FXMenuCaption.rb', line 29

def selTextColor
  @selTextColor
end

#shadowColorObject

Shadow color Fox::FXColor


35
36
37
# File 'rdoc-sources/FXMenuCaption.rb', line 35

def shadowColor
  @shadowColor
end

#textObject

The text for this menu [String]


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

def text
  @text
end

#textColorObject

Text color Fox::FXColor


23
24
25
# File 'rdoc-sources/FXMenuCaption.rb', line 23

def textColor
  @textColor
end

#tipTextObject

Tool tip message for this menu [String]


41
42
43
# File 'rdoc-sources/FXMenuCaption.rb', line 41

def tipText
  @tipText
end

Instance Method Details

#to_sObject

Return the menu caption's text


50
# File 'rdoc-sources/FXMenuCaption.rb', line 50

def to_s; text; end