wxruby3 0.9.0.pre.beta.8-x64-mingw-ucrt

data/lib/wx/doc/extra/08_extensions.md

@@ -0,0 +1,144 @@
+<!--
+# @markup markdown
+# @title 8. wxRuby Extensions
+-->
+
+# 8. wxRuby Extensions
+
+## Keyword Constructors
+
+The **Keyword Constructors** extension allows the use of Ruby hash-style
+keyword arguments in constructors of common WxWidgets Windows, Frame,
+Dialog and Control classes.
+
+### Introduction
+
+Building a GUI in WxWidgets involves lots of calls to +new+, but
+these methods often have long parameter lists. Often the default
+values for many of these parameters are correct. For example, if
+you're using a sizer-based layout, you usually don't want to specify a
+size for widgets, but you still have to type
+
+    Wx::TreeCtrl.new( parent, -1, Wx::DEFAULT_POSITION, Wx::DEFAULT_SIZE, Wx::NO_BUTTONS )
+
+just to create a standard TreeCtrl with the 'no buttons' style. If you
+want to specify the 'NO BUTTONS' style, you can't avoid all the typing
+of DEFAULT_POSITION etc.
+
+### Basic Keyword Constructors
+
+With keyword_constructors, you could write the above as
+
+    TreeCtrl.new(parent, :style => Wx::NO_BUTTONS)
+
+And it will assume you want the default id (-1), and the default size
+and position. If you want to specify an explicit size, you can do so:
+
+    TreeCtrl.new(parent, :size => Wx::Size.new(100, 300))
+
+For brevity, this module also allows you to specify positions and
+sizes using a a two-element array:
+
+    TreeCtrl.new(parent, :size => [100, 300])
+
+Similarly with position:
+
+    TreeCtrl.new(parent, :pos => Wx::Point.new(5, 25))
+    
+    TreeCtrl.new(parent, :pos => [5, 25])
+
+You can have multiple keyword arguments:
+
+    TreeCtrl.new(parent, :pos => [5, 25], :size => [100, 300] )
+
+### No ID required
+
+As with position and size, you usually don't want to deal with
+assigning unique ids to every widget and frame you create - it's a C++
+hangover that often seems clunky in Ruby. The **Event Connectors**
+extension allows you to set up event handling without having to use
+ids, and if no `:id` argument is supplied to a constructor, the default
+(-1) will be passed.
+
+There are occasions when a specific ID does need to be used - for
+example, to tell WxWidgets that a button is a 'stock' item, so that it
+can be displayed using platform-standard text and icon. To do this,
+simply pass an :id argument to the constructor - here, the system's
+standard 'preview' button
+
+    Wx::Button.new(parent, :id => Wx::ID_PREVIEW)
+
+### Class-specific arguments
+
+The arguments `:size`, `:pos` and `:style` are common to many WxWidgets
+window classes. The `new` methods of these classes also have
+parameters that are specific to those classes; for example, the text
+label on a button, or the initial value of a text control.
+
+    Wx::Button.new(parent, :label => 'press me')
+    Wx::TextCtrl.new(parent, :value => 'type some text here')
+
+The keyword names of these arguments can be found by looking at the
+WxRuby documentation, in the relevant class's +new+ method. You can
+also get a string description of the class's +new+ method parameters
+within Ruby by doing:
+
+    puts Wx::TextCtrl.describe_constructor()
+
+This will print a list of the argument names expected by the class's
++new+ method, and the correct type for them.
+
+### Mixing positional and keyword arguments
+
+To support existing code, and to avoid forcing the use of more verbose
+keyword-style arguments where they're not desired, you can mix
+positional and keyword arguments, omitting or including `id`s as
+desired.
+
+    Wx::Button.new(parent, 'press me', :style => Wx::BU_RIGHT)
+
+### Handling complex defaults or version differences
+
+To support complex (context dependent) defaults and/or auto conversion
+of arguments for backwards compatibility the keyword constructors
+extension allows the definition of lambdas or procs to be associated
+with a parameter specification.
+
+## Ruby-style accessors
+
+The wxWidgets API, in typical C++ style, has lots of accessor methods like
+
+- `GetPosition()`
+- `SetSize(a_size)`
+- `IsChecked()`
+- `CanUndo()`
+- `HasStyle(a_style)`
+
+which in wxRuby are mapped to Ruby methods like `get_position`, `set_size` etc.
+
+In Ruby however these kind of methods that set, get or query attributes or state are normally simply called
+by the attribute name or, in other cases, by a predicate method like:
+
+```ruby
+pos = frame.position
+frame.size = a_size
+item.checked?
+control.can_undo?
+window.has_style?(a_style)
+```
+
+With wxRuby3 (most of) the API methods that begin with *get_*, *set_*, *is_*, *can_* and *has_* are identified 
+and the wxRuby API will have Ruby-style accessor aliases defined for those (appropriately decorated as needed).
+Note that if you are calling a *'setter'* method on `self`, you must explicitly send the message to `self` like:
+
+```ruby
+# set's self size to be 100px by 100px
+self.size = Wx::Size.new(100, 100)
+```
+
+since this will not work as you expect it to:
+
+```ruby
+# only sets the value of a local variable 'size'
+size = Wx::Size.new
+```

data/lib/wx/doc/extra/09_exceptions.md

@@ -0,0 +1,54 @@
+<!--
+# @markup markdown
+# @title 9. wxRuby Exception Handling
+-->
+
+# 9. wxRuby Exception Handling
+
+The wxRuby library should (!) be completely exception safe, i.e. Ruby code raising an exception should not leak into
+the wrapped wxWidgets C++ code and cause unexpected exception handling or (worse) segmentation faults and should be 
+handled in ways expected of Ruby applications.
+
+As the wxWidgets library does not use exceptions for it's public API any raised exceptions should come either from the
+wxRuby wrapper code (signalling mostly typical Ruby-ish error situations like ArgumentError, TypeError and such) or from
+your own Ruby application code.
+
+Any exceptions raised from wxRuby wrapper code signal coding errors that need to be rectified.
+
+As far as handling application code exceptions is concerned the same advice applies as for wxWidgets itself; do **not**
+let exceptions escape your event handlers meaning that if you can reasonably expect application code to raise exceptions
+you should make sure to catch any such exceptions within the context of the event handler like:
+
+```ruby
+class MyForm < Wx::Frame
+  
+  def initialize(title)
+    super(nil, title: title)
+    
+    # initialize frame elements
+    # ...
+    
+    # setup event handlers
+    evt_menu MY_MENU_ID, :on_my_menu_item
+    
+    # ...
+  end
+  
+  def on_my_menu_item(evt)
+    begin
+      # execute some application code
+      # ...
+    rescue SomeException => ex 
+      # handle exception
+    end
+  end
+  
+  #...
+  
+end
+```
+
+In wxRuby event handler code is executed in an exception safe way which will capture any leaking exceptions. As wxRuby 
+however has no idea why this exception was raised and how to handle it, the result will be an exit of the main event loop
+of the running `Wx::App` instance and re-raising the exception to be handled by Ruby like any unhandled application 
+exception.

data/lib/wx/doc/functions.rb

@@ -0,0 +1,221 @@
+# Wx global methods
+#
+# Documentation stubs for global Wx methods
+
+
+module Wx
+
+  # @!group Logging methods
+
+  # Log a Wx message with the given logging level to the current Wx log output
+  # @param lvl  [Integer] logging level (like {Wx::LOG_Message})
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_generic(lvl, fmt, *args) end
+
+  # Log a Wx low priority informational message to the current Wx log output
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_info(fmt, *args) end
+
+  # Log a Wx Informational message to the current Wx log output
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_message(fmt, *args) end
+
+  # Log a Wx Error message to the current Wx log output
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_error(fmt, *args) end
+
+  # Log a Wx Warning message to the current Wx log output
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_warning(fmt, *args) end
+
+  # Log a Wx Status message - this is directed to the status bar of the
+  # specified Frame window, or the application main window if not specified.
+  # Based on Wx::Widgets code in src/generic/logg.cpp, WxLogGui::DoLog
+  # @overload log_status(win, fmt, *args)
+  #   @param win [Wx::Frame] window to log to
+  #   @param fmt  [String]  message (formatting) string
+  #   @param args [Array<Object>] optional message arguments
+  # @overload log_status(fmt, *args)
+  #   @param fmt  [String]  message (formatting) string
+  #   @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_status(fmt, *args) end
+
+  # Log a Wx verbose informational message to the current Wx log output
+  # (needs explicit activation to be shown)
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_verbose(fmt, *args) end
+
+  # Log a Wx debug message to the current Wx log output
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @return [nil]
+  def self.log_debug(fmt, *args) end
+
+  # @!endgroup
+
+  # @!group Other class methods
+
+  # Returns the global app object
+  # @return [Wx::App] the global app object
+  def self.get_app; end
+
+  # Returns the pointer address of the underlying C++ object as a hex
+  # string - useful for debugging
+  # @param obj [Object] wrapped object
+  # @return [String] string with address in hex format
+  def self.cpp_ptr_addr(obj) end
+
+  # Converts a string XRC id into a Wx id
+  # @param str [String] XRC id string
+  # @return [Integer] Wx Id
+  def self.xrcid(str) end
+
+  def self.begin_busy_cursor(cursor) end
+  def self.end_busy_cursor; end
+  def self.bell; end
+  def self.safe_yield(win = nil, only_if_needed = false) end
+
+  # @!endgroup
+
+  # @!group System information
+  
+  # @return [String]
+  def self.get_email_address; end
+  # @return [String]
+  def self.get_host_name; end
+  # @return [String]
+  def self.get_full_host_name; end
+  # @return [String]
+  def self.get_user_id; end
+  # @return [String]
+  def self.get_user_name; end
+  # @return [String]
+  def self.get_home_dir; end
+  
+  # @!endgroup
+
+  # @!group Mouse / keyboard information
+
+  # @return [true,false]
+  def self.get_key_state(key) end
+  # @return [Wx::Window]
+  def self.find_window_at_point(point) end
+  # @return [Wx::Window]
+  def self.get_active_window; end
+  # @return [Wx::Point]
+  def self.get_mouse_position; end
+  # @return [Wx::MouseState]
+  def self.get_mouse_state; end
+
+  # @!endgroup
+
+  # @!group Dialog shortcuts
+
+  # @return [Array<Integer>] Selected choices
+  def self.get_selected_choices(message, caption, choices,
+                                parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD,
+                                centre = true, width = Wx::CHOICE_WIDTH, height = Wx::CHOICE_HEIGHT) end
+
+  # Pops up a file selector box.
+  #
+  # In Windows, this is the common file selector dialog. In X, this is a file selector box with the same functionality.
+  # The path and filename are distinct elements of a full file pathname. If path is empty, the current directory will
+  # be used. If filename is empty, no default filename will be supplied. The wildcard determines what files are
+  # displayed in the file selector, and file extension supplies a type extension for the required filename. Flags may
+  # be a combination of Wx::FD_OPEN, Wx::FD_SAVE, Wx::FD_OVERWRITE_PROMPT or Wx::FD_FILE_MUST_EXIST.
+  #
+  # @note Wx::FD_MULTIPLE can only be used with Wx::FileDialog and not here since this function only returns a single file name.
+  #
+  # Both the Unix and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in
+  # the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed.
+  # The wildcard may be a specification for multiple types of file with a description for each, such as:
+  # <code>"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"</code>
+  #
+  # The application must check for an empty return value (the user pressed Cancel). For example:
+  # <code>
+  #   filename = Wx::file_selector("Choose a file to open")
+  #   unless filename.empty?
+  #     # work with the file
+  #     ...
+  #   end
+  #   # else: cancelled by user
+  # </code>
+  # @return [String] selected file name
+  def file_selector(message, default_path='', default_filename='', default_extension='', wildcard='',
+                    flags=0, parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD) end
+
+  # An extended version of {Wx::file_selector}.
+  # @return [String] selected file name
+  def file_selector_ex(message='Select a file', default_path='', default_filename='', indexDefaultExtension=nil,
+                       wildcard='*', flags=0, parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD) end
+
+  # Shows a file dialog asking the user for a file name for saving a file.
+  # @see Wx::file_selector, Wx::FileDialog
+  def load_file_selector(what,  extension, default_name='', parent=nil) end
+
+  # Shows a file dialog asking the user for a file name for opening a file.
+  # @see Wx::file_selector, Wx::FileDialog
+  def save_file_selector(what, extension, default_name='', parent=nil) end
+
+  # @!endgroup
+
+  # @!group Managing stock IDs
+
+  # Returns true if the ID is in the list of recognized stock actions
+  # @param [Integer] id ID to check
+  # @return [true,false]
+  def is_stock_id(id) end
+
+  # Returns true if the label is empty or label of a stock button with
+  # given ID
+  # @param [Integer] id ID to check
+  # @param [String] label to check
+  # @return [true,false]
+  def is_stock_label(id, label) end
+
+  STOCK_NOFLAGS = 0
+
+  STOCK_WITH_MNEMONIC = 1
+
+  STOCK_WITH_ACCELERATOR = 2
+
+  STOCK_WITHOUT_ELLIPSIS = 4
+
+  STOCK_FOR_BUTTON = STOCK_WITHOUT_ELLIPSIS | STOCK_WITH_MNEMONIC
+
+  # Returns label that should be used for given id element.
+  # @param [Integer] id	Given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
+  # @param [Integer] flags Combination of the elements of STOCK_xxx flags.
+  # @return [String]
+  def get_stock_label(id, flags = Wx::STOCK_WITH_MNEMONIC) end
+
+  # Returns the accelerator that should be used for given stock UI element
+  # (e.g. "Ctrl+X" for Wx::ID_CUT)
+  # @param [Integer] id stock UI element ID
+  # @return [Wx::AcceleratorEntry]
+  def get_stock_accelerator(id) end
+
+  STOCK_MENU = 0
+
+  # Returns a help string for the given stock UI element and for the given "context".
+  # @param [Integer] id stock UI element ID
+  # @param [Integer] client context (currently only STOCK_MENU)
+  # @return [String]
+  def get_stock_help_string(id, client = Wx::STOCK_MENU) end
+
+  # @!endgroup
+
+end

data/lib/wx/doc/gdi_common.rb

@@ -0,0 +1,181 @@
+###
+# wxRuby3 geometry classes
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+
+module Wx
+
+  class Size
+
+    # Returns size array (`[width, height]`)
+    # @return [Array(Integer,Integer)] size as array
+    def to_ary; end
+
+    # Compare size values (Wx::Size or size array). Throws exception if incompatible.
+    # @param [Wx::Size,Array(Integer,Integer)] other
+    # @return [Boolean]
+    def ==(other)end
+
+    # Compare sizes.
+    # @param [Wx::Size] other
+    # @return [Boolean]
+    def eql?(other)end
+
+    # Return a new Wx::Size with the width and height values both divided
+    # by parameter +num+, which should be a Numeric
+    # @param [Numeric] num
+    # @return [Wx::Size]
+    def /(num) end
+
+    # Return a new Wx::Size with the width and height values both multiplied
+    # by parameter +num+, which should be a Numeric
+    # @param [Numeric] num
+    # @return [Wx::Size]
+    def *(num) end
+
+    # Return a new Wx::Size with the width and height parameters both
+    # reduced by parameter +arg+. If +arg+ is another Wx::Size (or 2-element array), reduce
+    # width by the other's width and height by the other's height; if
+    # +arg+ is a numeric value, reduce both width and height by that
+    # value.
+    # @param [Wx::Size,Array(Integer,Integer),Numeric] arg
+    # @return [Wx::Size]
+    def -(arg) end
+
+    # Return a new Wx::Size with the width and height parameters both
+    # increased by parameter +arg+. If +arg+ is another Wx::Size (or 2-element array), increase
+    # width by the other's width and height by the other's height; if
+    # +arg+ is a numeric value, increase both width and height by that
+    # value.
+    # @param [Wx::Size,Array(Integer,Integer),Numeric] arg
+    # @return [Wx::Size]
+    def +(arg) end
+
+  end
+
+  class Point
+
+    # Returns point array (`[x, y]`)
+    # @return [Array(Integer,Integer)] point as array
+    def to_ary; end
+
+    # Compare point values (Wx::Point or point array). Throws exception if incompatible.
+    # @param [Wx::Point,Array(Integer,Integer)] other
+    # @return [Boolean]
+    def ==(other)end
+
+    # Compare points.
+    # @param [Wx::Point] other
+    # @return [Boolean]
+    def eql?(other)end
+
+    # Return a new Wx::Point with the x and y parameters both divided by
+    # parameter +num+, which should be a Numeric
+    # @param [Numeric] num
+    # @return [Wx::Point]
+    def /(num) end
+
+    # Return a new Wx::Point with the x and y values both multiplied by
+    # parameter +num+, which should be a Numeric
+    # @param [Numeric] num
+    # @return [Wx::Point]
+    def *(num) end
+
+    # Return a new Wx::Point with the x and y values both reduced by
+    # parameter +arg+. If +arg+ is another Wx::Point (or Wx::Size or 2-element array), reduce x by the
+    # other's x (or width) and y by the other's y (or height); if +arg+ is a numeric value,
+    # reduce x and y both by that value.
+    # @param [Wx::Point,Wx::Size,Array(Integer,Integer),Numeric] arg
+    # @return [Wx::Point]
+    def -(arg) end
+
+    # Return a new Wx::Point with the x and y values both increased by
+    # parameter +arg+. If +arg+ is another Wx::Point (or Wx::Size or 2-element array), increase x by the
+    # other's x (or width) and y by the other's y (or height); if +arg+ is a numeric value,
+    # increase both x and y by that value.
+    # @param [Wx::Point,Wx::Size,Array(Integer,Integer),Numeric] arg
+    # @return [Wx::Point]
+    def +(arg) end
+    
+  end
+
+  class RealPoint
+
+    # Returns point array (`[x, y]`)
+    # @return [Array(Float,Float)] point as array
+    def to_ary; end
+
+    # Compare point values (Wx::RealPoint or point array). Throws exception if incompatible.
+    # @param [Wx::RealPoint,Array(Float,Float)] other
+    # @return [Boolean]
+    def ==(other)end
+
+    # Compare points.
+    # @param [Wx::RealPoint] other
+    # @return [Boolean]
+    def eql?(other)end
+
+    # Return a new Wx::RealPoint with the x and y parameters both divided by
+    # parameter +num+, which should be a Numeric
+    # @param [Numeric] num
+    # @return [Wx::RealPoint]
+    def /(num) end
+
+    # Return a new Wx::RealPoint with the x and y values both multiplied by
+    # parameter +num+, which should be a Numeric
+    # @param [Numeric] num
+    # @return [Wx::RealPoint]
+    def *(num) end
+
+    # Return a new Wx::RealPoint with the x and y values both reduced by
+    # parameter +arg+. If +arg+ is another Wx::(Real)Point (or Wx::Size or 2-element array), reduce x by the
+    # other's x (or width) and y by the other's y (or height); if +arg+ is a numeric value,
+    # reduce x and y both by that value.
+    # @param [Wx::RealPoint,Wx::Point,Wx::Size,Array(Float,Float),Numeric] arg
+    # @return [Wx::RealPoint]
+    def -(arg) end
+
+    # Return a new Wx::RealPoint with the x and y values both increased by
+    # parameter +arg+. If +arg+ is another Wx::(Real)Point (or Wx::Size or 2-element array), increase x by the
+    # other's x (or width) and y by the other's y (or height); if +arg+ is a numeric value,
+    # increase both x and y by that value.
+    # @param [Wx::RealPoint,Wx::Point,Wx::Size,Array(Float,Float),Numeric] arg
+    # @return [Wx::RealPoint]
+    def +(arg) end
+
+  end
+
+  class Rect
+
+    # Returns rect array (`[left, top, width, height]`)
+    # @return [Array(Integer,Integer,Integer,Integer)] rect as array
+    def to_ary; end
+
+    # Compare area values (Wx::Rect or 4-element array). Throws exception if incompatible.
+    # @param [Wx::Rect,Array(Integer,Integer,Integer,Integer)] other
+    # @return [Boolean]
+    def ==(other)end
+
+    # Compare areas.
+    # @param [Wx::Rect] other
+    # @return [Boolean]
+    def eql?(other)end
+
+    alias :& :intersect
+
+    alias :| :union
+
+    # Returns the overlap of the rectangle areas.
+    # Does not check negative or zero overlap like #intersect.
+    # @param [Wx::Rect] rect
+    def *(rect) end
+
+    # Modifies the rectangle to contain the bounding box of this rectangle and the one passed in as parameter.
+    # Does not ignore empty rectangles like #union
+    # @param [Wx::Rect] rect
+    def +(rect) end
+
+  end
+
+end