Class: Fox::FXWizard

Inherits:
FXDialogBox show all
Defined in:
rdoc-sources/FXWizard.rb

Overview

An FXWizard widget guides the user through a number of panels in a predefined sequence; each step must be completed before moving on to the next step. For example, an FXWizard may be used to install software components, and ask various questions at each step in the installation.

Message identifiers

ID_NEXT

Move to the next panel in the wizard

ID_BACK

Move to the previous panel in the wizard

Instance Attribute Summary collapse

Attributes inherited from FXTopWindow

#decorations, #hSpacing, #icon, #miniIcon, #packingHints, #padBottom, #padLeft, #padRight, #padTop, #title, #vSpacing

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 FXDialogBox

#execute

Methods inherited from FXTopWindow

#close, #getWMBorders, #maximize, #maximized?, #minimize, #minimized?, #place, #restore, #show

Methods inherited from FXComposite

#maxChildHeight, #maxChildWidth

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(owner, name, image, opts = DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE, x = 0, y = 0, width = 0, height = 0, padLeft = 10, padRight = 10, padTop = 10, padBottom = 10, hSpacing = 10, vSpacing = 10) ⇒ FXWizard

Return an initialized FXWizard instance. If owner is a window, the dialog box will float over that window. If owner is the application, the dialog box will be free-floating.


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

def initialize(owner, name, image, opts=DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE, x=0, y=0, width=0, height=0, padLeft=10, padRight=10, padTop=10, padBottom=10, hSpacing=10, vSpacing=10) # :yields: theWizard
end

Instance Attribute Details

#advanceButtonObject (readonly)

The “Advance” button Fox::FXButton


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

def advanceButton
  @advanceButton
end

#buttonFrameObject (readonly)

The button frame Fox::FXHorizontalFrame


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

def buttonFrame
  @buttonFrame
end

#cancelButtonObject (readonly)

The “Cancel” button Fox::FXButton


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

def cancelButton
  @cancelButton
end

#containerObject (readonly)

The container used as parent for the sub-panels Fox::FXSwitcher


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

def container
  @container
end

#finishButtonObject (readonly)

The “Finish” button Fox::FXButton


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

def finishButton
  @finishButton
end

#imageObject

The image being displayed Fox::FXImage


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

def image
  @image
end

#retreatButtonObject (readonly)

The “Retreat” button Fox::FXButton


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

def retreatButton
  @retreatButton
end

Instance Method Details

#currentPanelObject

Return the index of the child window currently on top.


57
# File 'rdoc-sources/FXWizard.rb', line 57

def currentPanel; end

#currentPanel=(index) ⇒ Object

Bring the child window at index to the top. Raises IndexError if index is out of bounds.


52
# File 'rdoc-sources/FXWizard.rb', line 52

def currentPanel=(index); end

#numPanelsObject

Return the number of panels.


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

def numPanels; end