Class: Fox::FXProgressDialog

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

Overview

A progress dialog is a simple dialog which is used to keep a user informed of the progress of a lengthy operation in a program and that the program is in fact still working.

Options

PROGRESSDIALOG_NOCANCEL

Default is no cancel button

PROGRESSDIALOG_CANCEL

Enable the cancel button

PROGRESSDIALOG_NORMAL

same as DECOR_TITLE|DECOR_BORDER

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, caption, label, opts = PROGRESSDIALOG_NORMAL, x = 0, y = 0, width = 0, height = 0) ⇒ FXProgressDialog

Construct progress dialog box with given caption and message string.



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

def initialize(owner, caption, label, opts=PROGRESSDIALOG_NORMAL, x=0, y=0, width=0, height=0) # :yields: theProgressDialog
end

Instance Attribute Details

#message ⇒ Object

Progress message [String]



15
16
17
 
# File 'rdoc-sources/FXProgressDialog.rb', line 15

def message
  @message
end

#progress ⇒ Object

Amount of progress [Integer]



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

def progress
  @progress
end

#total ⇒ Object

Maximum value for progress [Integer]



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

def total
  @total
end

Instance Method Details

#cancelled? ⇒ Boolean

Return true if the operation was cancelled.

Returns:

  • (Boolean) 


33
 
# File 'rdoc-sources/FXProgressDialog.rb', line 33

def cancelled?; end

#increment(amount) ⇒ Object

Increment progress by given amount.



30
 
# File 'rdoc-sources/FXProgressDialog.rb', line 30

def increment(amount); end