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


module Wx

  # Small control showing an animation indicating that the program is currently busy performing some background task.
  # === 
  # 
  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
  #   </td><td> {Wx::GTK} Appearance
  #   </td><td> {Wx::OSX} Appearance
  #   </td></tr></table></div>
  # 
  class ActivityIndicator < Control
  
    # @overload initialize()
    #   Default constructor.
    #   Use {Wx::ActivityIndicator#create} to really create the control after using this constructor.
    #   @return [ActivityIndicator]
    # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("activityindicator"))
    #   Constructor fully creating the control.
    #   The arguments have the usual meanings and only parent is typically required.
    #   @param parent [Wx::Window] 
    #   @param winid [Integer] 
    #   @param pos [Array(Integer, Integer), Wx::Point] 
    #   @param size [Array(Integer, Integer), Wx::Size] 
    #   @param style [Integer] 
    #   @param name [String] 
    #   @return [ActivityIndicator]
    def initialize(*args) end
    
    # Create the control initialized using the default constructor.
    # This method can be used to finish the control creation if it hadn't been done already by using the non-default constructor.
    # @param parent [Wx::Window] 
    # @param winid [Integer] 
    # @param pos [Array(Integer, Integer), Wx::Point] 
    # @param size [Array(Integer, Integer), Wx::Size] 
    # @param style [Integer] 
    # @param name [String] 
    # @return [true,false]
    def create(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("activityindicator")) end
    
    # Starts animation of the indicator.
    # Does nothing if the indicator is already running.
    # @return [void]
    def start; end
    
    # Stops the animation of the indicator.
    # Notice that the animation is stopped even if {Wx::ActivityIndicator#start} had been called multiple times before, i.e. the calls are not cumulative.
    # @return [void]
    def stop; end
    
    # Returns true if the control is currently showing activity.
    # Returns false initially, true once {Wx::ActivityIndicator#start} is called and false again after calling {Wx::ActivityIndicator#stop}.
    # @return [true,false]
    def is_running; end
    alias_method :running?, :is_running
    
  end # ActivityIndicator
  

end