wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

data/lib/wx/doc/gen/timer.rb

@@ -7,6 +7,7 @@
 module Wx
 
   # The {Wx::Timer} class allows you to execute code at specified intervals.
+  # 
   # Its precision is platform-dependent, but in general will not be better than 1ms nor worse than 1s.
   # There are three different ways to use this class:
   # 
@@ -15,22 +16,28 @@ module Wx
   # - You may use a derived class and the EVT_TIMER macro to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from {Wx::EvtHandler}.
   # 
   # In any case, you must start the timer with {Wx::Timer#start} after constructing it before it actually starts sending notifications. It can be stopped later with {Wx::Timer#stop}.
-  # A timer can only be used from the main thread.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>A timer can only be used from the main thread.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::Miscellaneous}
   # @see Wx::StopWatch 
   # 
   # 
+  # @wxrb_require USE_TIMER
   class Timer < EvtHandler
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   If you use it to construct the object and don't call {Wx::Timer#set_owner} later, you must override {Wx::Timer#notify} method to process the notifications.
     #   @return [Wx::Timer]
     # @overload initialize(owner, id=-1)
     #   Creates a timer and associates it with owner.
+    #   
     #   Please see {Wx::Timer#set_owner} for the description of parameters.
     #   @param owner [Wx::EvtHandler] 
     #   @param id [Integer] 
@@ -48,6 +55,7 @@ module Wx
     alias_method :interval, :get_interval
     
     # Returns the current owner of the timer.
+    # 
     # If non-NULL this is the event handler which will receive the timer events (see {Wx::TimerEvent}) when the timer is running.
     # @return [Wx::EvtHandler]
     def get_owner; end
@@ -64,12 +72,14 @@ module Wx
     alias_method :running?, :is_running
     
     # This member should be overridden by the user if the default constructor was used and {Wx::Timer#set_owner} wasn't called.
+    # 
     # Perform whatever action which is to be taken periodically here.
     # Notice that throwing exceptions from this method is currently not supported, use event-based timer handling approach if an exception can be thrown while handling timer notifications.
     # @return [void]
     def notify; end
     
     # Associates the timer with the given owner object.
+    # 
     # When the timer is running, the owner will receive timer events (see {Wx::TimerEvent}) with id equal to id specified here.
     # @param owner [Wx::EvtHandler] 
     # @param id [Integer] 
@@ -78,6 +88,7 @@ module Wx
     alias_method :owner=, :set_owner
     
     # (Re)starts the timer.
+    # 
     # If milliseconds parameter is -1 (value by default), the previous value is used. Returns false if the timer could not be started, true otherwise (in MS Windows timers are a limited resource).
     # If oneShot is false (the default), the {Wx::Timer#notify} function will be called repeatedly until the timer is stopped. If true, it will be called only once and the timer will stop automatically.
     # To make your code more readable you may also use the following symbolic constants:
@@ -92,6 +103,7 @@ module Wx
     def start(milliseconds=-1, oneShot=Wx::TIMER_CONTINUOUS) end
     
     # Starts the timer for a once-only notification.
+    # 
     # This is a simple wrapper for {Wx::Timer#start} with {Wx::TIMER_ONE_SHOT} parameter.
     # @param milliseconds [Integer] 
     # @return [Boolean]

data/lib/wx/doc/gen/timer_event.rb

@@ -17,6 +17,7 @@ module Wx
   EVT_TIMER = 10005
   
   # {Wx::TimerEvent} object is passed to the event handler of timer events (see {Wx::Timer#set_owner}).
+  # 
   # For example:
   # 
   # ```ruby
@@ -40,12 +41,11 @@ module Wx
   #   end
   # ```
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::Timer 
   # 
   # 
+  # @wxrb_require USE_TIMER
   class TimerEvent < Event
   
     # @param timer [Wx::Timer] 

data/lib/wx/doc/gen/tip_provider.rb

@@ -8,6 +8,7 @@ module Wx
 
   # This function creates a {Wx::TipProvider} which may be used with {show_tip}.
   # 
+  # 
   # @see wxTipProvider Overview
   # @param filename [String]  The name of the file containing the tips, one per line.
   # @param currentTip [Integer]  The index of the first tip to show. Normally this index is remembered between the 2 program runs.
@@ -15,6 +16,7 @@ module Wx
   def self.create_file_tip_provider(filename, currentTip) end
   
   # This function shows a "startup tip" to the user.
+  # 
   # The return value is the state of the "Show tips at startup" checkbox.
   # @see wxTipProvider Overview
   # @param parent [Wx::Window]  The parent window for the modal dialog.
@@ -24,15 +26,16 @@ module Wx
   def self.show_tip(parent, tipProvider, showAtStartup=true) end
   
   # This is the class used together with {show_tip} function.
+  # 
   # It must implement {Wx::TipProvider#get_tip} function and return the current tip from it (different tip each time it is called).
   # You will never use this class yourself, but you need it to show startup tips with {show_tip}. Also, if you want to get the tips text from elsewhere than a simple text file, you will want to derive a new class from {Wx::TipProvider} and use it instead of the one returned by {create_file_tip_provider}.
-  # === 
   # 
   # Category:  {Wx::Miscellaneous}
   # @see wxTipProvider Overview
   # @see  show_tip 
   # 
   # 
+  # @wxrb_require USE_STARTUP_TIPS
   class TipProvider < ::Object
   
     # Constructor.
@@ -41,12 +44,14 @@ module Wx
     def initialize(currentTip) end
     
     # Returns the index of the current tip (i.e. the one which would be returned by {Wx::TipProvider#get_tip}).
+    # 
     # The program usually remembers the value returned by this function after calling {show_tip}. Note that it is not the same as the value which was passed to {show_tip} + 1 because the user might have pressed the "Next" button in the tip dialog.
     # @return [Integer]
     def get_current_tip; end
     alias_method :current_tip, :get_current_tip
     
     # Return the text of the current tip and pass to the next one.
+    # 
     # This function is pure virtual, it should be implemented in the derived classes.
     # @return [String]
     def get_tip; end

data/lib/wx/doc/gen/toggle_button.rb

@@ -11,27 +11,27 @@ module Wx
   EVT_TOGGLEBUTTON = 10188
   
   # {Wx::ToggleButton} is a button that stays pressed when clicked by the user.
+  # 
   # In other words, it is similar to {Wx::CheckBox} in functionality but looks like a {Wx::Button}.
   # Since wxWidgets version 2.9.0 this control emits an update UI event.
   # You can see {Wx::ToggleButton} in action in Widgets Sample.
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_togglebutton}(id, meth = nil, &block): Handles a {Wx::EVT_TOGGLEBUTTON} event. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::CheckBox
   # @see  Wx::Button
   # @see  Wx::BitmapToggleButton 
   # 
   # 
+  # @wxrb_require USE_TOGGLEBTN
   class ToggleButton < AnyButton
   
     # @overload initialize()
@@ -40,6 +40,7 @@ module Wx
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, val=Wx::DEFAULT_VALIDATOR, name=Wx::CHECK_BOX_NAME_STR)
     #   Constructor, creating and showing a toggle button.
     #   
+    #   
     #   @see Wx::ToggleButton#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -54,6 +55,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the toggle button for two-step construction.
+    # 
     # See {Wx::ToggleButton#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -67,12 +69,14 @@ module Wx
     def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, val=Wx::DEFAULT_VALIDATOR, name=Wx::CHECK_BOX_NAME_STR) end
     
     # Gets the state of the toggle button.
+    # 
     # Returns true if it is pressed, false otherwise.
     # @return [Boolean]
     def get_value; end
     alias_method :value, :get_value
     
     # Sets the toggle button to the given state.
+    # 
     # This does not cause a EVT_TOGGLEBUTTON event to be emitted.
     # @param state [Boolean]  If true, the button is pressed.
     # @return [void]
@@ -81,5 +85,68 @@ module Wx
     
   end # ToggleButton
   
+  # {Wx::BitmapToggleButton} is a {Wx::ToggleButton} that contains a bitmap instead of text.
+  # 
+  # This class is not available in all ports currently (although it is available in the major ones), test for {Wx::HAS_BITMAPTOGGLEBUTTON} to determine whether it can be used (in addition for possibly testing for {Wx::Setup::USE_TOGGLEBTN} which can be set to 0 to explicitly disable support for this class and {Wx::ToggleButton}).
+  # This control emits an update UI event.
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_togglebutton}(id, meth = nil, &block): Handles a {Wx::EVT_TOGGLEBUTTON} event. 
+  # 
+  # Category:  {Wx::Controls}
+  # 
+  # @wxrb_require USE_TOGGLEBTN
+  class BitmapToggleButton < ToggleButton
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::BitmapToggleButton]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, val=Wx::DEFAULT_VALIDATOR, name=Wx::CHECK_BOX_NAME_STR)
+    #   Constructor, creating and showing a toggle button with the bitmap label.
+    #   
+    #   Internally calls {Wx::BitmapToggleButton#create}.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param val [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Wx::BitmapToggleButton]
+    def initialize(*args) end
+    
+    # Create method for two-step construction.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param label [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param val [Wx::Validator] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, val=Wx::DEFAULT_VALIDATOR, name=Wx::CHECK_BOX_NAME_STR) end
+    
+    # Gets the state of the toggle button.
+    # 
+    # Returns true if it is pressed, false otherwise.
+    # @return [Boolean]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Sets the toggle button to the given state.
+    # 
+    # This does not cause a EVT_TOGGLEBUTTON event to be emitted.
+    # @param state [Boolean]  If true, the button is pressed.
+    # @return [void]
+    def set_value(state) end
+    alias_method :value=, :set_value
+    
+  end # BitmapToggleButton
+  
 
 end