wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.1-x64-mingw-ucrt

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

@@ -0,0 +1,152 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # An info bar is a transient window shown at top or bottom of its parent window to display non-critical information to the user.
+  # This class provides another way to show messages to the user, intermediate between message boxes and status bar messages. The message boxes are modal and thus interrupt the users work flow and should be used sparingly for this reason. However status bar messages are often too easy not to notice at all. An info bar provides a way to present the messages which has a much higher chance to be noticed by the user but without being annoying.
+  # Info bar may show an icon (on the left), text message and, optionally, buttons allowing the user to react to the information presented. Unless a custom button was added to the info bar, it also has a close button at the right allowing the user to dismiss it so it isn't necessary to provide a button just to close it.
+  # {Wx::InfoBar} calls its parent {Wx::Window#layout} method and assumes that it will change the parent layout appropriately depending on whether the info bar itself is shown or hidden. Usually this is achieved by simply using a sizer for the parent window layout and adding {Wx::InfoBar} to this sizer as one of the items. Considering the usual placement of the info bars, normally this sizer should be a vertical {Wx::BoxSizer} and the bar its first or last element so the simplest possible example of using this class would be: 
+  # ```
+  #   class MyFrame : public wxFrame
+  #   {
+  #       ...
+  #   
+  #       wxInfoBar *m_infoBar;
+  #   };
+  #   
+  #   MyFrame::MyFrame()
+  #   {
+  #       ...
+  #       m_infoBar = new wxInfoBar(this);
+  #   
+  #       wxSizer *sizer = new wxBoxSizer(wxVERTICAL);
+  #       sizer->Add(m_infoBar, wxSizerFlags().Expand());
+  #       ... add other frame controls to the sizer ...
+  #       SetSizer(sizer);
+  #   }
+  #   
+  #   void MyFrame::SomeMethod()
+  #   {
+  #       m_infoBar->ShowMessage("Something happened", wxICON_INFORMATION);
+  #   }
+  # ```
+  # 
+  # See the dialogs sample for more sophisticated examples.
+  # Currently this class is implemented generically (i.e. in the same platform-independent way for all ports) and also natively in wxGTK but the native implementation requires GTK+ 2.18 version or later (this requirement should be satisfied by any desktop systems currently in use).
+  # === 
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::StatusBar
+  # @see  Wx::MessageDialog
+  # 
+  # 
+  class InfoBar < Control
+  
+    # Set the effects to use when showing and hiding the bar.
+    # Either or both of the parameters can be set to {Wx::ShowEffect::SHOW_EFFECT_NONE} to disable using effects entirely.
+    # By default, the info bar uses {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_BOTTOM} effect for showing itself and {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_TOP} for hiding if it is the first element of the containing sizer and reverse effects if it's the last one. If it is neither the first nor the last element, no effect is used to avoid the use of an inappropriate one and this function must be called if an effect is desired.
+    # @param showEffect [Wx::ShowEffect]  The effect to use when showing the bar.
+    # @param hideEffect [Wx::ShowEffect]  The effect to use when hiding the bar.
+    # @return [void]
+    def set_show_hide_effects(showEffect, hideEffect) end
+    
+    # Return the effect currently used for showing the bar.
+    # @return [Wx::ShowEffect]
+    def get_show_effect; end
+    alias_method :show_effect, :get_show_effect
+    
+    # Return the effect currently used for hiding the bar.
+    # @return [Wx::ShowEffect]
+    def get_hide_effect; end
+    alias_method :hide_effect, :get_hide_effect
+    
+    # Set the duration of the animation used when showing or hiding the bar.
+    # By default, 500ms duration is used.
+    # @param duration [Integer]  Duration of the animation, in milliseconds.
+    # @return [void]
+    def set_effect_duration(duration) end
+    alias_method :effect_duration=, :set_effect_duration
+    
+    # Return the effect animation duration currently used.
+    # @return [Integer]
+    def get_effect_duration; end
+    alias_method :effect_duration, :get_effect_duration
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   Use {Wx::InfoBar#create} for the objects created using this constructor.
+    #   @return [Wx::InfoBar]
+    # @overload initialize(parent, winid=Wx::StandardID::ID_ANY)
+    #   Constructor creating the info bar window.
+    #   
+    #   @see Wx::InfoBar#create 
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @return [Wx::InfoBar]
+    def initialize(*args) end
+    
+    # Create the info bar window.
+    # Notice that unlike most of the other {Wx::Window}-derived classes, {Wx::InfoBar} is created hidden and is only shown when {Wx::InfoBar#show_message} is called. This is more convenient as usually the info bar is created to be shown at some later time and not immediately and so creating it hidden avoids the need to call {Wx::InfoBar#hide} explicitly from the code using it.
+    # This should be only called if the object was created using its default constructor.
+    # @param parent [Wx::Window]  A valid parent window pointer.
+    # @param winid [Integer]  The id of the info bar window, usually unused as currently no events are generated by this class.
+    # @return [Boolean]
+    def create(parent, winid=Wx::StandardID::ID_ANY) end
+    
+    # Add a button to be shown in the info bar.
+    # The button added by this method will be shown to the right of the text (in LTR layout), with each successive button being added to the right of the previous one. If any buttons are added to the info bar using this method, the default "Close" button is not shown as it is assumed that the extra buttons already allow the user to close it.
+    # Clicking the button will generate a normal EVT_COMMAND_BUTTON_CLICKED event which can be handled as usual. The default handler in {Wx::InfoBar} itself closes the window whenever a button in it is clicked so if you wish the info bar to be hidden when the button is clicked, simply call <code>event.Skip()</code> in the button handler to let the base class handler do it (calling {Wx::InfoBar#dismiss} explicitly works too, of course). On the other hand, if you don't skip the event, the info bar will remain opened so make sure to do it for at least some buttons to allow the user to close it.
+    # Notice that the generic {Wx::InfoBar} implementation handles the button events itself and so they are not propagated to the info bar parent and you need to either inherit from {Wx::InfoBar} and handle them in your derived class or use {Wx::EvtHandler#bind}, as is done in the dialogs sample, to handle the button events in the parent frame.
+    # @param btnid [Integer]  Id of the button. It will be used in the button message clicking this button will generate.
+    # @param label [String]  The label of the button. It may only be empty if btnid is one of the stock ids in which case the corresponding stock label (see {get_stock_label}) will be used.
+    # @return [void]
+    def add_button(btnid, label=(())) end
+    
+    # Hide the info bar window.
+    # This method hides the window and lays out the parent window to account for its disappearance (unlike a simple {Wx::InfoBar#hide}).
+    # @return [void]
+    def dismiss; end
+    
+    # Remove a button previously added by {Wx::InfoBar#add_button}.
+    # @param btnid [Integer]  Id of the button to remove. If more than one button with the same id is used in the info bar (which is in any case not recommended), the last, i.e. most recently added, button with this id is removed.
+    # @return [void]
+    def remove_button(btnid) end
+    
+    # Show a message in the bar.
+    # If the bar is currently hidden, it will be shown. Otherwise its message will be updated in place.
+    # @param msg [String]  The text of the message.
+    # @param flags [Integer]  One of {Wx::ICON_NONE}, {Wx::ICON_INFORMATION} (default), {Wx::ICON_QUESTION}, {Wx::ICON_WARNING} or {Wx::ICON_ERROR} values. These flags have the same meaning as in {Wx::MessageDialog} for the generic version, i.e. show (or not, in case of {Wx::ICON_NONE}) the corresponding icon in the bar but can be interpreted by the native versions. For example, the GTK+ native implementation doesn't show icons at all but uses this parameter to select the appropriate background colour for the notification.
+    # @return [void]
+    def show_message(msg, flags=Wx::ICON_INFORMATION) end
+    
+    # Returns the number of currently shown buttons.
+    # This is simply the number of calls to {Wx::InfoBar#add_button} minus the number of calls to {Wx::InfoBar#remove_button} so far.
+    # The number of currently shown buttons, possibly 0.
+    # @return [Integer]
+    def get_button_count; end
+    alias_method :button_count, :get_button_count
+    
+    # Returns the ID of the button at the given position.
+    # The positions of the buttons are counted in order of their addition.
+    # 
+    # The ID of the button at the given position or {Wx::StandardID::ID_NONE} if it is out of range (this also results in an assertion failure).
+    # @param idx [Integer]  The position of the button in 0 to {Wx::InfoBar#get_button_count} range.
+    # @return [Integer]
+    def get_button_id(idx) end
+    alias_method :button_id, :get_button_id
+    
+    # Returns whether a button with the given ID is currently shown.
+    # true if the button with this ID is currently shown.
+    # @param btnid [Integer]  ID of the button to check for.
+    # @return [Boolean]
+    def has_button_id(btnid) end
+    alias_method :has_button_id?, :has_button_id
+    
+  end # InfoBar
+  
+
+end

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

@@ -22,10 +22,10 @@ module Wx
   
     # Constructor initializes the modifier key settings.
     # By default, no modifiers are active.
-    # @param controlDown [true,false] 
-    # @param shiftDown [true,false] 
-    # @param altDown [true,false] 
-    # @param metaDown [true,false] 
+    # @param controlDown [Boolean] 
+    # @param shiftDown [Boolean] 
+    # @param altDown [Boolean] 
+    # @param metaDown [Boolean] 
     # @return [Wx::KeyboardState]
     def initialize(controlDown=false, shiftDown=false, altDown=false, metaDown=false) end
     
@@ -53,73 +53,73 @@ module Wx
     # Returns true if any modifiers at all are pressed.
     # This is equivalent to <code>Wx::KeyboardState#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
     # Notice that this is different from {Wx::KeyboardState#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
-    # @return [true,false]
+    # @return [Boolean]
     def has_any_modifiers; end
     alias_method :has_any_modifiers?, :has_any_modifiers
     
     # Returns true if Control or Alt are pressed.
     # Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
     # This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::KeyboardState#has_any_modifiers} if you want to take Shift into account as well.
-    # @return [true,false]
+    # @return [Boolean]
     def has_modifiers; end
     alias_method :has_modifiers?, :has_modifiers
     
     # Returns true if the Control key or Apple/Command key under macOS is pressed.
     # This function doesn't distinguish between right and left control keys.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
-    # @return [true,false]
+    # @return [Boolean]
     def control_down; end
     
     # Returns true if the Control key (also under macOS).
     # This function doesn't distinguish between right and left control keys.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
-    # @return [true,false]
+    # @return [Boolean]
     def raw_control_down; end
     
     # Returns true if the Shift key is pressed.
     # This function doesn't distinguish between right and left shift keys.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
-    # @return [true,false]
+    # @return [Boolean]
     def shift_down; end
     
     # Returns true if the Meta/Windows/Apple key is pressed.
     # This function tests the state of the key traditionally called Meta under Unix systems, Windows keys under MSW Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @see Wx::KeyboardState#cmd_down 
-    # @return [true,false]
+    # @return [Boolean]
     def meta_down; end
     
     # Returns true if the Alt key is pressed.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
-    # @return [true,false]
+    # @return [Boolean]
     def alt_down; end
     
     # Returns true if the key used for command accelerators is pressed.
     # Same as {Wx::KeyboardState#control_down}. Deprecated.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
-    # @return [true,false]
+    # @return [Boolean]
     def cmd_down; end
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_control_down(down) end
     alias_method :control_down=, :set_control_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_raw_control_down(down) end
     alias_method :raw_control_down=, :set_raw_control_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_shift_down(down) end
     alias_method :shift_down=, :set_shift_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_alt_down(down) end
     alias_method :alt_down=, :set_alt_down
     
-    # @param down [true,false] 
+    # @param down [Boolean] 
     # @return [void]
     def set_meta_down(down) end
     alias_method :meta_down=, :set_meta_down

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

@@ -55,9 +55,9 @@ module Wx
   # 
   class ListBox < ControlWithItems
   
-    # @overload create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
+    # @overload create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Creates the listbox for two-step construction.
-    #   See {Wx::ListBox#list_box} for further details.
+    #   See {Wx::ListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -66,10 +66,10 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
-    # @overload create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
+    #   @return [Boolean]
+    # @overload create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Creates the listbox for two-step construction.
-    #   See {Wx::ListBox#list_box} for further details.
+    #   See {Wx::ListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -78,13 +78,13 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::ListBox]
-    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Constructor, creating and showing a list box.
     #   @param parent [Wx::Window]  The parent window.
     #   @param id [Integer]  The ID of this control. A value of {Wx::StandardID::ID_ANY} indicates a default value.
@@ -95,9 +95,9 @@ module Wx
     #   @param validator [Wx::Validator]  The validator for this control.
     #   @param name [String]  The name of this class.
     #   @return [Wx::ListBox]
-    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
+    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Constructor, creating and showing a list box.
-    #   See the other {Wx::ListBox#list_box} constructor; the only difference is that this overload takes a {Wx::ArrayString} instead of a pointer to an array of {Wx::String}.
+    #   See the other {Wx::ListBox#initialize} constructor; the only difference is that this overload takes a {Wx::ArrayString} instead of a pointer to an array of {Wx::String}.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -130,17 +130,17 @@ module Wx
     # This method can be used with single selection list boxes only, you must use {Wx::ListBox#get_selections} for the list boxes with {Wx::LB_MULTIPLE} style.
     # @see Wx::ListBox#set_selection
     # @see  Wx::ListBox#get_string_selection 
-    # @return []
+    # @return [Integer]
     def get_selection; end
     alias_method :selection, :get_selection
     
     # @overload set_string_selection(s, select)
     #   @param s [String] 
-    #   @param select [true,false] 
-    #   @return [true,false]
+    #   @param select [Boolean] 
+    #   @return [Boolean]
     # @overload set_string_selection(s)
     #   @param s [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def set_string_selection(*args) end
     alias_method :string_selection=, :set_string_selection
     
@@ -151,22 +151,22 @@ module Wx
     # @see Wx::ControlWithItems::GetSelection
     # @see  Wx::ControlWithItems::GetStringSelection
     # @see  Wx::ControlWithItems::SetSelection 
-    # @return [Array(,Array<Integer>)]
+    # @return [Array<Integer>]
     def get_selections; end
     alias_method :selections, :get_selections
     
     # @overload hit_test(point)
     #   Returns the item located at point, or {Wx::NOT_FOUND} if there is no item located at point.
-    #   It is currently implemented for wxMSW, {Wx::Mac} and wxGTK2 ports.
+    #   It is currently implemented for wxMSW, wxMac and wxGTK2 ports.
     #   
     #   Item located at point, or {Wx::NOT_FOUND} if unimplemented or the item does not exist.
     #   @param point [Array(Integer, Integer), Wx::Point]  Point of item (in client coordinates) to obtain
-    #   @return []
+    #   @return [Integer]
     # @overload hit_test(x, y)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return []
+    #   @return [Integer]
     def hit_test(*args) end
     
     # Insert the given number of strings before the specified position.
@@ -178,7 +178,7 @@ module Wx
     # Determines whether an item is selected.
     # true if the given item is selected, false otherwise.
     # @param n [Integer]  The zero-based item index.
-    # @return [true,false]
+    # @return [Boolean]
     def is_selected(n) end
     alias_method :selected?, :is_selected
     
@@ -201,13 +201,13 @@ module Wx
     
     # Return the number of items that can fit vertically in the visible area of the listbox.
     # Returns -1 if the number of items per page couldn't be determined. On wxGTK this method can only determine the number of items per page if there is at least one item in the listbox.
-    # @return []
+    # @return [Integer]
     def get_count_per_page; end
     alias_method :count_per_page, :get_count_per_page
     
     # Return the index of the topmost visible item.
     # Returns {Wx::NOT_FOUND} if the method is not implemented for the current platform.
-    # @return []
+    # @return [Integer]
     def get_top_item; end
     alias_method :top_item, :get_top_item
     
@@ -220,13 +220,13 @@ module Wx
     # 
     # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param tabStops [Wx::Vector< int >]  If this argument is empty, tab stops are reset to their default value (every 32 dialog units). If it contains a single element, tab stops are set at each multiple of the given value. Otherwise tab stops are set at every element of the array, which must be in ascending order.
-    # @return [true,false]
+    # @return [Boolean]
     def msw_set_tab_stops(tabStops) end
     
     # Returns the number of items in the control.
     # 
     # @see Wx::ListBox#is_empty 
-    # @return []
+    # @return [Integer]
     def get_count; end
     alias_method :count, :get_count
     
@@ -248,8 +248,8 @@ module Wx
     # Finds an item whose label matches the given string.
     # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
     # @param string [String]  String to find.
-    # @param caseSensitive [true,false]  Whether search is case sensitive (default is not).
-    # @return []
+    # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
+    # @return [Integer]
     def find_string(string, caseSensitive=false) end
     
   end # ListBox