wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -6,6 +6,46 @@
 
 module Wx
 
+  # Symbolic names for the mouse buttons.
+  # 
+  # 
+  # 
+  class MouseButton < Wx::Enum
+  
+    # Any mouse button, means to check for any button being pressed for example.
+    # 
+    MOUSE_BTN_ANY = Wx::MouseButton.new(-1)
+    
+    # None of the mouse buttons.
+    # 
+    MOUSE_BTN_NONE = Wx::MouseButton.new(0)
+    
+    # Left mouse button.
+    # 
+    MOUSE_BTN_LEFT = Wx::MouseButton.new(1)
+    
+    # Middle mouse button.
+    # 
+    MOUSE_BTN_MIDDLE = Wx::MouseButton.new(2)
+    
+    # Right mouse button.
+    # 
+    MOUSE_BTN_RIGHT = Wx::MouseButton.new(3)
+    
+    # First additional mouse button.
+    # 
+    MOUSE_BTN_AUX1 = Wx::MouseButton.new(4)
+    
+    # Second additional mouse button.
+    # 
+    MOUSE_BTN_AUX2 = Wx::MouseButton.new(5)
+    
+    # 
+    # 
+    MOUSE_BTN_MAX = Wx::MouseButton.new(6)
+    
+  end # MouseButton
+  
   # Represents the mouse state.
   # This class is used as a base class by {Wx::MouseEvent} and so its methods may be used to obtain information about the mouse state for the mouse events. It also inherits from {Wx::KeyboardState} and so carries information about the keyboard state and not only the mouse one.
   # This class is implemented entirely inline in <{Wx::/mousestate.h}> and thus has no linking requirements.
@@ -26,7 +66,7 @@ module Wx
     alias_method :position, :get_position
     
     # Default constructor.
-    # @return [MouseState]
+    # @return [Wx::MouseState]
     def initialize; end
     
     # Returns X coordinate of the physical mouse event position.
@@ -40,23 +80,23 @@ module Wx
     alias_method :y, :get_y
     
     # Returns true if the left mouse button is currently down.
-    # @return [true,false]
+    # @return [Boolean]
     def left_is_down; end
     
     # Returns true if the middle mouse button is currently down.
-    # @return [true,false]
+    # @return [Boolean]
     def middle_is_down; end
     
     # Returns true if the right mouse button is currently down.
-    # @return [true,false]
+    # @return [Boolean]
     def right_is_down; end
     
     # Returns true if the first extra button mouse button is currently down.
-    # @return [true,false]
+    # @return [Boolean]
     def aux1is_down; end
     
     # Returns true if the second extra button mouse button is currently down.
-    # @return [true,false]
+    # @return [Boolean]
     def aux2is_down; end
     
     # @param x [Integer] 
@@ -74,27 +114,27 @@ module Wx
     def set_position(pos) end
     alias_method :position=, :set_position
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_left_down(down) end
     alias_method :left_down=, :set_left_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_middle_down(down) end
     alias_method :middle_down=, :set_middle_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_right_down(down) end
     alias_method :right_down=, :set_right_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_aux1down(down) end
     alias_method :aux1down=, :set_aux1down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_aux2down(down) end
     alias_method :aux2down=, :set_aux2down

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

@@ -10,9 +10,11 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::OK}: Show an OK button. 
+  # 
   # - {Wx::CANCEL}: Show a Cancel button. 
+  # 
   # - {Wx::GeometryCentre::CENTRE}: Centre the message. 
   # 
   # === 
@@ -32,7 +34,7 @@ module Wx
     # @param choices [Array<String>]  An array of strings, or a string list, containing the choices.
     # @param style [Integer]  A dialog style (bitlist) containing flags chosen from standard dialog styles and the ones listed in the class documentation. The default value is equivalent to {Wx::DEFAULT_DIALOG_STYLE} | {Wx::RESIZE_BORDER} | {Wx::OK} | {Wx::CANCEL} | {Wx::GeometryCentre::CENTRE}.
     # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
-    # @return [MultiChoiceDialog]
+    # @return [Wx::MultiChoiceDialog]
     def initialize(parent, message, caption, choices, style=Wx::CHOICEDLG_STYLE, pos=Wx::DEFAULT_POSITION) end
     
     # Returns array with indexes of selected items.

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

@@ -21,23 +21,22 @@ module Wx
     #   This method is available in this class only since wxWidgets 2.9.3, previous versions only provided it in {Wx::TopLevelWindow}.
     #   Note that windows with non default shape have a fixed size and can't be resized using {Wx::NonOwnedWindow#set_size}.
     #   @param region [Wx::Region] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload set_shape(path)
     #   Set the window shape to the given path.
     #   Set the window shape to the interior of the given path and also draw the window border along the specified path.
     #   For example, to make a clock-like circular window you could use 
-    #   ```
-    #     wxSize size = GetSize();
-    #     wxGraphicsPath
-    #         path = wxGraphicsRenderer::GetDefaultRenderer()->CreatePath();
-    #     path.AddCircle(size.x/2, size.y/2, 30);
-    #     SetShape(path);
+    #   ```ruby
+    #     size = get_size
+    #     path = Wx::GraphicsRenderer.get_default_renderer.create_path
+    #     path.add_circle(size.x/2, size.y/2, 30)
+    #     set_shape(path)
     #   ```
     #   
     #   Note that windows with non default shape have a fixed size and can't be resized using {Wx::NonOwnedWindow#set_size}.
-    #   As the overload above, this method is not guaranteed to work on all platforms but currently does work in {Wx::MSW}, {Wx::OSX}/Cocoa and {Wx::GTK} (with the appropriate but almost always present X11 extensions) ports.
+    #   As the overload above, this method is not guaranteed to work on all platforms but currently does work in wxMSW, wxOSX/Cocoa and wxGTK (with the appropriate but almost always present X11 extensions) ports.
     #   @param path [Wx::GraphicsPath] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def set_shape(*args) end
     alias_method :shape=, :set_shape
     

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

@@ -64,13 +64,19 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::NB_TOP}: Place tabs on the top side. 
+  # 
   # - {Wx::NB_LEFT}: Place tabs on the left side. 
+  # 
   # - {Wx::NB_RIGHT}: Place tabs on the right side. 
+  # 
   # - {Wx::NB_BOTTOM}: Place tabs under instead of above the notebook pages. 
+  # 
   # - {Wx::NB_FIXEDWIDTH}: (Windows only) All tabs will have same width. 
+  # 
   # - {Wx::NB_MULTILINE}: (Windows only) There can be several rows of tabs. 
+  # 
   # - {Wx::NB_NOPAGETHEME}: (Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance. 
   # 
   # The styles {Wx::NB_LEFT}, RIGHT and BOTTOM are not supported under Microsoft Windows when using visual themes.
@@ -78,32 +84,31 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_notebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_NOTEBOOK_PAGE_CHANGED} event. 
+  # 
   # - {Wx::EvtHandler#evt_notebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_NOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
   # 
   # == Page backgrounds
   # 
   # On Windows, the default theme paints a background on the notebook's pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use {Wx::NB_NOPAGETHEME} to disable themed drawing for a particular notebook, you can call {Wx::SystemOptions.set_option} to disable it for the whole application, or you can disable it for individual pages by using {Wx::Notebook#set_background_colour}.
   # To disable themed pages globally: 
-  # ```
-  #   wxSystemOptions::SetOption("msw.notebook.themed-background", 0);
+  # ```ruby
+  #   Wx::SystemOptions.set_option("msw.notebook.themed-background", 0)
   # ```
   # 
   # Set the value to 1 to enable it again. To give a single page a solid background that more or less fits in with the overall theme, use: 
-  # ```
-  #   wxColour col = notebook->GetThemeBackgroundColour();
-  #   if (col.IsOk())
-  #   {
-  #       page->SetBackgroundColour(col);
-  #   }
+  # ```ruby
+  #   col = notebook.get_theme_background_colour
+  #   page.set_background_colour(col) if col.ok?
   # ```
   # 
   # On platforms other than Windows, or if the application is not using Windows themes, {Wx::Notebook#get_theme_background_colour} will return an uninitialised colour object, and the above code will therefore work on all platforms.
   # === 
   # 
-  # Category:  Book 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
+  # Category:  Book 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::BookCtrl
   # @see  Wx::BookCtrlEvent
@@ -115,7 +120,7 @@ module Wx
   
     # @overload initialize()
     #   Constructs a notebook control.
-    #   @return [Notebook]
+    #   @return [Wx::Notebook]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::NotebookNameStr)
     #   Constructs a notebook control.
     #   Note that sometimes you can reduce flicker by passing the {Wx::CLIP_CHILDREN} window style.
@@ -125,18 +130,18 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  The window size.
     #   @param style [Integer]  The window style. See {Wx::Notebook}.
     #   @param name [String]  The name of the control.
-    #   @return [Notebook]
+    #   @return [Wx::Notebook]
     def initialize(*args) end
     
     # Creates a notebook control.
-    # See {Wx::Notebook#notebook} for a description of the parameters.
+    # See {Wx::Notebook#initialize} for a description of the parameters.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::NotebookNameStr) end
     
     # Returns the number of rows in the notebook control.
@@ -151,7 +156,7 @@ module Wx
     alias_method :theme_background_colour, :get_theme_background_colour
     
     # Sets the amount of space around each page's icon and label, in pixels.
-    # The vertical padding cannot be changed in {Wx::GTK}.
+    # The vertical padding cannot be changed in wxGTK.
     # @param padding [Array(Integer, Integer), Wx::Size] 
     # @return [void]
     def set_padding(padding) end
@@ -167,7 +172,7 @@ module Wx
     # image is an index into the image list which was set with {Wx::Notebook#set_image_list}.
     # @param page [Integer] 
     # @param image [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_page_image(page, image) end
     
     # Returns the string for the given page.
@@ -179,7 +184,7 @@ module Wx
     # Sets the text for the given page.
     # @param page [Integer] 
     # @param text [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_page_text(page, text) end
     
     # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
@@ -211,10 +216,10 @@ module Wx
     # @param index [Integer]  Specifies the position for the new page.
     # @param page [Wx::Window]  Specifies the new page.
     # @param text [String]  Specifies the text for the new page.
-    # @param select [true,false]  Specifies whether the page should be selected.
+    # @param select [Boolean]  Specifies whether the page should be selected.
     # @param imageId [Integer]  Specifies the optional image index for the new page.
-    # @return [true,false]
-    def insert_page(index, page, text, select=false, imageId=Wx::AUI::AuiMDIClientWindow::NO_IMAGE) end
+    # @return [Boolean]
+    def insert_page(index, page, text, select=false, imageId=Wx::Notebook::NO_IMAGE) end
     
   end # Notebook
   

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

@@ -36,7 +36,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   Call {Wx::NumberEntryDialog#create} to really create the dialog later.
-    #   @return [NumberEntryDialog]
+    #   @return [Wx::NumberEntryDialog]
     # @overload initialize(parent, message, prompt, caption, value, min, max, pos=Wx::DEFAULT_POSITION)
     #   Constructor.
     #   Use {Wx::NumberEntryDialog#show_modal} to show the dialog.
@@ -49,7 +49,7 @@ module Wx
     #   @param min [Integer] 
     #   @param max [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
-    #   @return [NumberEntryDialog]
+    #   @return [Wx::NumberEntryDialog]
     def initialize(*args) end
     
     # @param parent [Wx::Window]  Parent window.
@@ -60,7 +60,7 @@ module Wx
     # @param min [Integer]  The minimal value.
     # @param max [Integer]  The maximal value.
     # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, message, prompt, caption, value, min, max, pos=Wx::DEFAULT_POSITION) end
     
     # Returns the value that the user has entered if the user has pressed OK, or the original value if the user has pressed Cancel.

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

@@ -30,12 +30,12 @@ module Wx
   
     # @overload initialize()
     #   Default ctor; initializes to NULL the internal reference data.
-    #   @return [Object]
+    #   @return [Wx::Object]
     # @overload initialize(other)
     #   Copy ctor.
     #   Sets the internal {Wx::Object::m_refData} pointer to point to the same instance of the {Wx::ObjectRefData}-derived class pointed by other and increments the refcount of {Wx::Object::m_refData}.
     #   @param other [Wx::Object] 
-    #   @return [Object]
+    #   @return [Wx::Object]
     def initialize(*args) end
     
     # Returns true if this object has the same data pointer as obj.
@@ -43,21 +43,10 @@ module Wx
     # This function only does a shallow comparison, i.e. it doesn't compare the objects pointed to by the data pointers of these objects.
     # @see Reference Counting 
     # @param obj [Wx::Object] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_same_as(obj) end
     alias_method :same_as?, :is_same_as
     
-    # Sets the {Wx::Object::m_refData} pointer.
-    # 
-    # @see Wx::Object#ref
-    # @see  Wx::Object#un_ref
-    # @see  Wx::Object#get_ref_data
-    # @see  Wx::ObjectRefData 
-    # @param data [Wx::ObjectRefData] 
-    # @return [void]
-    def set_ref_data(data) end
-    alias_method :ref_data=, :set_ref_data
-    
     # This is the same of {Wx::Object#alloc_exclusive} but this method is public.
     # @return [void]
     def un_share; end

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

@@ -27,31 +27,29 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Palette]
+    #   @return [Wx::Palette]
     # @overload initialize(palette)
     #   Copy constructor, uses Reference Counting.
     #   @param palette [Wx::Palette]  A reference to the palette to copy.
-    #   @return [Palette]
-    # @overload initialize(n, red, green, blue)
+    #   @return [Wx::Palette]
+    # @overload initialize(n, green, blue)
     #   Creates a palette from arrays of size n, one for each red, blue or green component.
     #   
     #   @see Wx::Palette#create 
-    #   @param n [Integer]  The number of indices in the palette.
-    #   @param red [unsigned char]  An array of red values.
-    #   @param green [unsigned char]  An array of green values.
-    #   @param blue [unsigned char]  An array of blue values.
-    #   @return [Palette]
+    #   @param n [Array<Integer>]  The number of indices in the palette.
+    #   @param green [Array<Integer>]  An array of green values.
+    #   @param blue [Array<Integer>]  An array of blue values.
+    #   @return [Wx::Palette]
     def initialize(*args) end
     
     # Creates a palette from arrays of size n, one for each red, blue or green component.
     # true if the creation was successful, false otherwise.
-    # @see Wx::Palette#palette 
-    # @param n [Integer]  The number of indices in the palette.
-    # @param red [unsigned char]  An array of red values.
-    # @param green [unsigned char]  An array of green values.
-    # @param blue [unsigned char]  An array of blue values.
-    # @return [true,false]
-    def create(n, red, green, blue) end
+    # @see Wx::Palette#initialize 
+    # @param n [Array<Integer>]  The number of indices in the palette.
+    # @param green [Array<Integer>]  An array of green values.
+    # @param blue [Array<Integer>]  An array of blue values.
+    # @return [Boolean]
+    def create(n, green, blue) end
     
     # Returns number of entries in palette.
     # @return [Integer]
@@ -75,12 +73,12 @@ module Wx
     # @param red [unsigned char]  Receives the red value.
     # @param green [unsigned char]  Receives the green value.
     # @param blue [unsigned char]  Receives the blue value.
-    # @return [true,false]
+    # @return [Boolean]
     def get_rgb(pixel, red, green, blue) end
     alias_method :rgb, :get_rgb
     
     # Returns true if palette data is present.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     

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

@@ -7,7 +7,7 @@
 module Wx
 
   # A panel is a window on which controls are placed.
-  # It is usually placed within a frame. Its main feature over its parent class {Wx::Window} is code for handling child windows and TAB traversal, which is implemented natively if possible (e.g. in {Wx::GTK}) or by wxWidgets itself otherwise.
+  # It is usually placed within a frame. Its main feature over its parent class {Wx::Window} is code for handling child windows and TAB traversal, which is implemented natively if possible (e.g. in wxGTK) or by wxWidgets itself otherwise.
   # Tab traversal is implemented through an otherwise undocumented intermediate {Wx::ControlContainer} class from which any class can derive in addition to the normal {Wx::Window} base class. Please see <code>Wx::/containr.h</code> and <code>Wx::/panel.h</code> to find out how this is achieved.
   # 
   # if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the {Wx::TAB_TRAVERSAL} style, which grabs some keypresses for use by child controls.
@@ -18,6 +18,7 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event. 
   # 
   # === 
@@ -30,7 +31,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Panel]
+    #   @return [Wx::Panel]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TAB_TRAVERSAL, name=Wx::PanelNameStr)
     #   Constructor.
     #   
@@ -41,23 +42,23 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  The panel size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
     #   @param style [Integer]  The window style. See {Wx::Panel}.
     #   @param name [String]  Window name.
-    #   @return [Panel]
+    #   @return [Wx::Panel]
     def initialize(*args) end
     
     # This method is overridden from {Wx::Window#accepts_focus} and returns true only if there is no child window in the panel which can accept the focus.
     # This is reevaluated each time a child window is added or removed from the panel.
-    # @return [true,false]
+    # @return [Boolean]
     def accepts_focus; end
     
     # Used for two-step panel construction.
-    # See {Wx::Panel#panel} for details.
+    # See {Wx::Panel#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TAB_TRAVERSAL, name=Wx::PanelNameStr) end
     
     # Sends a {Wx::InitDialogEvent}, which in turn transfers data to the dialog via validators.
@@ -67,7 +68,7 @@ module Wx
     def init_dialog; end
     
     # See {Wx::Window#set_auto_layout}: when auto layout is on, this function gets called automatically when the window is resized.
-    # @return [true,false]
+    # @return [Boolean]
     def layout; end
     
     # The default handler for {Wx::EVT_SYS_COLOUR_CHANGED}.