class Tk::Tile::Progressbar

progressbar widget shows the status of a long-running operation. They can operate in two modes: determinate mode shows the amount completed relative to the total amount of work to be done, and indeterminate mode provides an animated display to let the user know that something is happening.

Public Class Methods

tk_command() click to toggle source
# File lib/ffi-tk/widget/tile/progressbar.rb, line 10
def self.tk_command
  'ttk::progressbar'
end

Public Instance Methods

identify(x, y) click to toggle source
# File lib/ffi-tk/widget/tile/progressbar.rb, line 46
def identify(x, y)
  execute(:identify, x, y)
end
orient(orientation = None) click to toggle source

Specifies the orientation of the scrollbar. horizontal or vertical

# File lib/ffi-tk/widget/tile/progressbar.rb, line 52
def orient(orientation = None)
  if None == orientation
    cget(:orient)
  else
    configure orient: orientation
  end
end
phase() click to toggle source
# File lib/ffi-tk/widget/tile/progressbar.rb, line 42
def phase
  execute(:cget, '-phase').to_i
end
start(interval = None) click to toggle source

Begin autoincrement mode schedules a recurring timer event that calls step every interval milliseconds. If omitted, interval defaults to 50 milliseconds (20 steps/second).

# File lib/ffi-tk/widget/tile/progressbar.rb, line 19
def start(interval = None)
  execute_only(:start, interval)
end
step(amount = 1.0) click to toggle source

Increments the -value by amount. amount defaults to 1.0 if omitted.

# File lib/ffi-tk/widget/tile/progressbar.rb, line 30
def step(amount = 1.0)
  execute_only(:step, amount)
end
stop() click to toggle source

Stop autoincrement mode cancels any recurring timer event initiated by start

# File lib/ffi-tk/widget/tile/progressbar.rb, line 25
def stop
  execute_only(:stop)
end
value() click to toggle source

the current value of the progress bar. In determinate mode, this represents the amount of work completed. In indeterminate mode, it is interpreted modulo -maximum; that is, the progress bar completes one 'cycle' when the -value increases by -maximum.

# File lib/ffi-tk/widget/tile/progressbar.rb, line 38
def value
  execute(:cget, '-value').to_f
end