wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,10 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+
+end

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

@@ -0,0 +1,157 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  GA_HORIZONTAL = 4
+  
+  # 
+  GA_VERTICAL = 8
+  
+  # 
+  GA_PROGRESS = 16
+  
+  # 
+  GA_SMOOTH = 32
+  
+  # 
+  GA_TEXT = 64
+  
+  # A gauge is a horizontal or vertical bar which shows a quantity (often time).
+  # 
+  # {Wx::Gauge} supports two working modes: determinate and indeterminate progress.
+  # The first is the usual working mode (see {Wx::Gauge#set_value} and {Wx::Gauge#set_range}) while the second can be used when the program is doing some processing but you don't know how much progress is being done. In this case, you can periodically call the {Wx::Gauge#pulse} function to make the progress bar switch to indeterminate mode (graphically it's usually a set of blocks which move or bounce in the bar control).
+  # {Wx::Gauge} supports dynamic switch between these two work modes.
+  # There are no user commands for the gauge.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::GA_HORIZONTAL}: Creates a horizontal gauge. 
+  # 
+  # - {Wx::GA_VERTICAL}: Creates a vertical gauge. 
+  # 
+  # - {Wx::GA_SMOOTH}: Creates smooth progress bar with one pixel wide update step (not supported by all platforms). 
+  # 
+  # - {Wx::GA_TEXT}: Display the current value in percents in the gauge itself. This style is only supported in {Wx::Qt} and ignored under the other platforms. This flag is only available in wxWidgets 3.1.0 and later. 
+  # 
+  # - {Wx::GA_PROGRESS}: Reflect the value of gauge in the application taskbar button under Windows 7 and later and the dock icon under macOS, ignored under the other platforms. This flag is only available in wxWidgets 3.1.0 and later. 
+  # 
+  # 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::Slider
+  # @see  Wx::ScrollBar 
+  # 
+  # 
+  # @wxrb_require USE_GAUGE
+  class Gauge < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::Gauge]
+    # @overload initialize(parent, id, range, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::GA_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::GAUGE_NAME_STR)
+    #   Constructor, creating and showing a gauge.
+    #   
+    #   
+    #   @see Wx::Gauge#create 
+    #   @param parent [Wx::Window]  Window parent.
+    #   @param id [Integer]  Window identifier.
+    #   @param range [Integer]  Integer range (maximum value) of the gauge. See {Wx::Gauge#set_range} for more details about the meaning of this value when using the gauge in indeterminate mode.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size.
+    #   @param style [Integer]  Gauge style.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::Gauge]
+    # @overload initialize(parent, id, range, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::GA_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::GAUGE_NAME_STR, &block)
+    #   Constructor, creating and showing a gauge.
+    #   
+    #   
+    #   @see Wx::Gauge#create 
+    #   @param parent [Wx::Window]  Window parent.
+    #   @param id [Integer]  Window identifier.
+    #   @param range [Integer]  Integer range (maximum value) of the gauge. See {Wx::Gauge#set_range} for more details about the meaning of this value when using the gauge in indeterminate mode.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size.
+    #   @param style [Integer]  Gauge style.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::Gauge] win new instance
+    #   @return [Wx::Gauge]
+    def initialize(*args) end
+    
+    # Creates the gauge for two-step construction.
+    # 
+    # See {Wx::Gauge#initialize} for further details.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param range [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param validator [Wx::Validator] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id, range, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::GA_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::GAUGE_NAME_STR) end
+    
+    # Returns the maximum position of the gauge.
+    # 
+    # 
+    # @see Wx::Gauge#set_range 
+    # @return [Integer]
+    def get_range; end
+    alias_method :range, :get_range
+    
+    # Returns the current position of the gauge.
+    # 
+    # 
+    # @see Wx::Gauge#set_value 
+    # @return [Integer]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Returns true if the gauge is vertical (has {Wx::GA_VERTICAL} style) and false otherwise.
+    # @return [Boolean]
+    def is_vertical; end
+    alias_method :vertical?, :is_vertical
+    
+    # Switch the gauge to indeterminate mode (if required) and makes the gauge move a bit to indicate the user that some progress has been made.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>After calling this function the value returned by {Wx::Gauge#get_value} is undefined and thus you need to explicitly call {Wx::Gauge#set_value} if you want to restore the determinate mode. 
+    # </p>
+    # </div>
+    # @return [void]
+    def pulse; end
+    
+    # Sets the range (maximum value) of the gauge.
+    # 
+    # This function makes the gauge switch to determinate mode, if it's not already.
+    # When the gauge is in indeterminate mode, under WXMSW the gauge repeatedly goes from zero to range and back; under other ports when in indeterminate mode, the range setting is ignored.
+    # @see Wx::Gauge#get_range 
+    # @param range [Integer] 
+    # @return [void]
+    def set_range(range) end
+    alias_method :range=, :set_range
+    
+    # Sets the position of the gauge.
+    # 
+    # The pos must be between 0 and the gauge range as returned by {Wx::Gauge#get_range}, inclusive.
+    # This function makes the gauge switch to determinate mode, if it was in indeterminate mode before.
+    # @see Wx::Gauge#get_value 
+    # @param pos [Integer]  Position for the gauge level.
+    # @return [void]
+    def set_value(pos) end
+    alias_method :value=, :set_value
+    
+  end # Gauge
+  
+
+end

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

@@ -0,0 +1,68 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The {Wx::GBSizerItem} class is used by the {Wx::GridBagSizer} for tracking the items in the sizer.
+  # 
+  # It adds grid position and spanning information to the normal {Wx::SizerItem} by adding {Wx::GBPosition} and {Wx::GBSpan} attributes. Most of the time you will not need to use a {Wx::GBSizerItem} directly in your code, but there are a couple of cases where it is handy.
+  # 
+  # Category:  Window Layout
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class GBSizerItem < SizerItem
+  
+    # Get the grid position of the item.
+    # @return [Wx::GBPosition]
+    def get_pos; end
+    alias_method :pos, :get_pos
+    
+    # Get the row and column spanning of the item.
+    # @return [Wx::GBSpan]
+    def get_span; end
+    alias_method :span, :get_span
+    
+    # Get the row and column of the endpoint of this item.
+    # @return [Array(Integer,Integer)]
+    def get_end_pos; end
+    alias_method :end_pos, :get_end_pos
+    
+    # @overload intersects(other)
+    #   Returns true if this item and the other item intersect.
+    #   @param other [Wx::GBSizerItem] 
+    #   @return [Boolean]
+    # @overload intersects(pos, span)
+    #   Returns true if the given pos/span would intersect with this item.
+    #   @param pos [Wx::GBPosition] 
+    #   @param span [Wx::GBSpan] 
+    #   @return [Boolean]
+    def intersects(*args) end
+    
+    # If the item is already a member of a sizer then first ensure that there is no other item that would intersect with this one at the new position, then set the new position.
+    # 
+    # Returns true if the change is successful and after the next Layout the item will be moved.
+    # @param pos [Wx::GBPosition] 
+    # @return [Boolean]
+    def set_pos(pos) end
+    alias_method :pos=, :set_pos
+    
+    # If the item is already a member of a sizer then first ensure that there is no other item that would intersect with this one with its new spanning size, then set the new spanning.
+    # 
+    # Returns true if the change is successful and after the next Layout the item will be resized.
+    # @param span [Wx::GBSpan] 
+    # @return [Boolean]
+    def set_span(span) end
+    alias_method :span=, :set_span
+    
+    # @return [Wx::GridBagSizer]
+    def get_gb_sizer; end
+    alias_method :gb_sizer, :get_gb_sizer
+    
+  end # GBSizerItem
+  
+
+end

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

@@ -0,0 +1,46 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::GCDC} is a device context that draws on a {Wx::GraphicsContext}.
+  # 
+  # {Wx::GCDC} does its best to implement {Wx::DC} API, but the following features are not (fully) implemented because {Wx::GraphicsContext} doesn't support them:
+  # 
+  # - {Wx::GCDC#get_pixel} method is not implemented and always returns false because modern graphics layers don't support retrieving the contents of the drawn pixels.
+  # - {Wx::GCDC#flood_fill} method is not, and can't be, implemented, as its functionality relies on reading the pixels from {Wx::GraphicsContext} too.
+  # - {Wx::GCDC#set_logical_function} method only works with {Wx::RasterOperationMode::COPY}, {Wx::RasterOperationMode::OR}, {Wx::RasterOperationMode::NO_OP}, {Wx::RasterOperationMode::CLEAR} and {Wx::RasterOperationMode::XOR} functions, attempts to use any other function (including {Wx::RasterOperationMode::INVERT}) don't do anything.
+  # - Similarly, {Wx::RasterOperationMode} parameter of {Wx::GCDC#blit} and {Wx::GCDC#stretch_blit} can only be one of the supported logical functions listed above, using any other function will result in an assertion failure and not drawing anything.
+  # - For Direct2D-based {Wx::GraphicsContext}, only true-type fonts can be used in the font-related functions.
+  # 
+  # Category:  Device Contexts
+  # @see Wx::DC
+  # @see  Wx::GraphicsContext 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRAPHICS_CONTEXT
+  class GCDC < DC
+  
+    # Retrieves associated {Wx::GraphicsContext}.
+    # @return [Wx::GraphicsContext]
+    def get_graphics_context; end
+    alias_method :graphics_context, :get_graphics_context
+    
+    # Set the graphics context to be used for this {Wx::GCDC}.
+    # 
+    # Note that this object takes ownership of context and will delete it when it is destroyed or when {Wx::GCDC#set_graphics_context} is called again.
+    # Also, unlike the constructor taking {Wx::GraphicsContext}, this method will reapply the current font, pen and brush, so that this object continues to use them, if they had been changed before (which is never the case when constructing {Wx::GCDC} directly from {Wx::GraphicsContext}).
+    # @param context [Wx::GraphicsContext] 
+    # @return [void]
+    def set_graphics_context(context) end
+    alias_method :graphics_context=, :set_graphics_context
+    
+  end # GCDC
+  
+
+end