Codebase list ruby-fxruby / ddfc60e rdoc-sources / FXProgressDialog.rb
ddfc60e

Tree @ddfc60e (Download .tar.gz)

FXProgressDialog.rb @ddfc60e — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
module Fox
  #
  # 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 <tt>DECOR_TITLE|DECOR_BORDER</tt>
  #
  class FXProgressDialog < FXDialogBox
    # Progress message [String]
    attr_accessor :message

    # Amount of progress [Integer]
    attr_accessor :progress

    # Maximum value for progress [Integer]
    attr_accessor :total

    #
    # Construct progress dialog box with given caption and message string.
    #
    def initialize(owner, caption, label, opts=PROGRESSDIALOG_NORMAL, x=0, y=0, width=0, height=0) # :yields: theProgressDialog
    end

    # Increment progress by given _amount_.
    def increment(amount); end

    # Return true if the operation was cancelled.
    def cancelled?; end
  end
end