# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx

  # 
  PD_CAN_ABORT = 1
  
  # 
  PD_APP_MODAL = 2
  
  # 
  PD_AUTO_HIDE = 4
  
  # 
  PD_ELAPSED_TIME = 8
  
  # 
  PD_ESTIMATED_TIME = 16
  
  # 
  PD_SMOOTH = 32
  
  # 
  PD_REMAINING_TIME = 64
  
  # 
  PD_CAN_SKIP = 128
  
  # If supported by the platform this class will provide the platform's native progress dialog, else it will simply be the {Wx::GenericProgressDialog}.
  # 
  # 
  class ProgressDialog < Dialog
  
    # @param title [String] 
    # @param message [String] 
    # @param maximum [Integer] 
    # @param parent [Wx::Window] 
    # @param style [Integer] 
    # @return [Wx::ProgressDialog]
    def initialize(title, message, maximum=100, parent=nil, style=(Wx::PD_APP_MODAL|Wx::PD_AUTO_HIDE)) end
    
    # Returns the last value passed to the {Wx::ProgressDialog#update} function or {Wx::NOT_FOUND} if the dialog has no progress bar.
    # @return [Integer]
    def get_value; end
    alias_method :value, :get_value
    
    # Returns the maximum value of the progress meter, as passed to the constructor or {Wx::NOT_FOUND} if the dialog has no progress bar.
    # @return [Integer]
    def get_range; end
    alias_method :range, :get_range
    
    # Returns the last message passed to the {Wx::ProgressDialog#update} function; if you always passed {Wx::EmptyString} to {Wx::ProgressDialog#update} then the message set through the constructor is returned.
    # @return [String]
    def get_message; end
    alias_method :message, :get_message
    
    # Can be used to continue with the dialog, after the user had clicked the "Abort" button.
    # @return [void]
    def resume; end
    
    # Changes the maximum value of the progress meter given in the constructor.
    # This function can only be called (with a positive value) if the value passed in the constructor was positive.
    # @param maximum [Integer] 
    # @return [void]
    def set_range(maximum) end
    alias_method :range=, :set_range
    
    # Returns true if the "Cancel" button was pressed.
    # Normally a Cancel button press is indicated by {Wx::ProgressDialog#update} returning false but sometimes it may be more convenient to check if the dialog was cancelled from elsewhere in the code and this function allows doing it.
    # It always returns false if the Cancel button is not shown at all.
    # @return [Boolean]
    def was_cancelled; end
    
    # Returns true if the "Skip" button was pressed.
    # This is similar to {Wx::ProgressDialog#was_cancelled} but returns true if the "Skip" button was pressed, not the "Cancel" one.
    # @return [Boolean]
    def was_skipped; end
    
  end # ProgressDialog
  

end