wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,77 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  CLRP_USE_TEXTCTRL = 2
+  
+  # 
+  CLRP_DEFAULT_STYLE = 0
+  
+  # 
+  CLRP_SHOW_LABEL = 8
+  
+  # 
+  CLRP_SHOW_ALPHA = 16
+  
+  # 
+  # 
+  EVT_COLOURPICKER_CHANGED = 10148
+  
+  # 
+  # 
+  EVT_COLOURPICKER_CURRENT_CHANGED = 10149
+  
+  # 
+  # 
+  EVT_COLOURPICKER_DIALOG_CANCELLED = 10150
+  
+  # This event class is used for the events generated by {Wx::ColourPickerCtrl}.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ColourPickerEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_colourpicker_changed}(id, meth = nil, &block): Generated whenever the selected colour changes. 
+  # 
+  # - {Wx::EvtHandler#evt_colourpicker_current_changed}(id, meth = nil, &block): Generated whenever the currently selected colour in the dialog shown by the picker changes. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW. 
+  # 
+  # - {Wx::EvtHandler#evt_colourpicker_dialog_cancelled}(id, meth = nil, &block): Generated when the user cancels the colour dialog associated with the control, i.e. closes it without accepting the selection. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW. 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::ColourPickerCtrl 
+  # 
+  # 
+  # @wxrb_require USE_COLOURPICKERCTRL,USE_COLOURDLG
+  class ColourPickerEvent < CommandEvent
+  
+    # @overload initialize()
+    #   @return [Wx::ColourPickerEvent]
+    # @overload initialize(generator, id, colour)
+    #   The constructor is not normally used by the user code.
+    #   @param generator [Wx::Object] 
+    #   @param id [Integer] 
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @return [Wx::ColourPickerEvent]
+    def initialize(*args) end
+    
+    # Retrieve the colour the user has just selected.
+    # @return [Wx::Colour]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+    # Set the colour associated with the event.
+    # @param pos [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(pos) end
+    alias_method :colour=, :set_colour
+    
+  end # ColourPickerEvent
+  
+
+end

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

@@ -0,0 +1,292 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A combobox is like a combination of an edit control and a listbox.
+  # 
+  # It can be displayed as static list with editable or read-only text field; or a drop-down list with text field; or a drop-down list without a text field depending on the platform and presence of {Wx::CB_READONLY} style.
+  # A combobox permits a single selection only. Combobox items are numbered from zero.
+  # If you need a customized combobox, have a look at {Wx::ComboCtrl}, {Wx::OwnerDrawnComboBox}, {Wx::ComboPopup} and the ready-to-use {Wx::BitmapComboBox}.
+  # Please refer to {Wx::TextEntry} documentation for the description of methods operating with the text entry part of the combobox and to {Wx::ItemContainer} for the methods operating with the list of strings. Notice that at least under MSW {Wx::ComboBox} doesn't behave correctly if it contains strings differing in case only so portable programs should avoid adding such strings to this control.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CB_SIMPLE}: Creates a combobox with a permanently displayed list. Windows only. 
+  # 
+  # - {Wx::CB_DROPDOWN}: Creates a combobox with a drop-down list. MSW only. 
+  # 
+  # - {Wx::CB_READONLY}: A combobox with this style behaves like a {Wx::Choice} (and may look in the same way as well, although this is platform-dependent), i.e. it allows the user to choose from the list of options but doesn't allow to enter a value not present in the list. 
+  # 
+  # - {Wx::CB_SORT}: Sorts the entries in the list alphabetically. 
+  # 
+  # - {Wx::TE_PROCESS_ENTER}: The control will generate the event {Wx::EVT_TEXT_ENTER} that can be handled by the program. Otherwise, i.e. either if this style not specified at all, or it is used, but there is no event handler for this event or the event handler called {Wx::Event#skip} to avoid overriding the default handling, pressing Enter key is either processed internally by the control or used to activate the default button of the dialog, if any. 
+  # 
+  # ### 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_combobox}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX} event, when an item on the list is selected. Note that calling {Wx::ComboBox#get_value} returns the new value of selection. 
+  # 
+  # - {Wx::EvtHandler#evt_text}(id, meth = nil, &block): Process a {Wx::EVT_TEXT} event, when the combobox text changes. 
+  # 
+  # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox (notice that the combobox must have been created with {Wx::TE_PROCESS_ENTER} style to receive this event). 
+  # 
+  # - {Wx::EvtHandler#evt_combobox_dropdown}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX_DROPDOWN} event, which is generated when the list box part of the combo box is shown (drops down). Notice that this event is only supported by WXMSW, WXGTK with GTK+ 2.10 or later, and WXOSX/Cocoa. 
+  # 
+  # - {Wx::EvtHandler#evt_combobox_closeup}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX_CLOSEUP} event, which is generated when the list box of the combo box disappears (closes up). This event is only generated for the same platforms as {Wx::EVT_COMBOBOX_DROPDOWN} above. 
+  # 
+  # 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::ListBox
+  # @see  Wx::TextCtrl
+  # @see  Wx::Choice
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  # @wxrb_require USE_COMBOBOX
+  class ComboBox < ControlWithItems
+  
+    include Wx::TextEntry
+  
+    # @overload create(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Creates the combobox for two-step construction.
+    #   
+    #   Derived classes should call or replace this function. See {Wx::ComboBox#initialize} for further details.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param value [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param choices [Array<String>] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Boolean]
+    # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Creates the combobox for two-step construction.
+    #   
+    #   Derived classes should call or replace this function. See {Wx::ComboBox#initialize} for further details.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param value [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param choices [Array<String>] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Boolean]
+    def create(*args) end
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::ComboBox]
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::ComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection. Notice that for the controls with {Wx::CB_READONLY} style this string must be one of the valid choices if it is not empty.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::ComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::ComboBox]
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::ComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection. Notice that for the controls with {Wx::CB_READONLY} style this string must be one of the valid choices if it is not empty.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::ComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::ComboBox] win new instance
+    #   @return [Wx::ComboBox]
+    # @overload initialize(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::ComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::ComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::ComboBox]
+    # @overload initialize(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::ComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::ComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::ComboBox] win new instance
+    #   @return [Wx::ComboBox]
+    def initialize(*args) end
+    
+    # Returns the item being selected right now.
+    # 
+    # This function does the same things as {Wx::Choice#get_current_selection} and returns the item currently selected in the dropdown list if it's open or the same thing as {Wx::ControlWithItems#get_selection} otherwise.
+    # @return [Integer]
+    def get_current_selection; end
+    alias_method :current_selection, :get_current_selection
+    
+    # Same as {Wx::TextEntry#get_insertion_point}.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Under WXMSW, this function always returns 0 if the combobox doesn't have the focus. 
+    # </p>
+    # </div>
+    # @return [Integer]
+    def get_insertion_point; end
+    alias_method :insertion_point, :get_insertion_point
+    
+    # Returns true if the list of combobox choices is empty.
+    # 
+    # Use this method instead of (not available in this class) {Wx::ComboBox#is_empty} to test if the list of items is empty.
+    # @return [Boolean]
+    def is_list_empty; end
+    alias_method :list_empty?, :is_list_empty
+    
+    # Returns true if the text of the combobox is empty.
+    # 
+    # Use this method instead of (not available in this class) {Wx::ComboBox#is_empty} to test if the text currently entered into the combobox is empty.
+    # @return [Boolean]
+    def is_text_empty; end
+    alias_method :text_empty?, :is_text_empty
+    
+    # Same as {Wx::TextEntry#set_selection}.
+    # @param from [Integer] 
+    # @param to [Integer] 
+    # @return [void]
+    def set_text_selection_range(from, to) end
+    
+    # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
+    # 
+    # Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
+    # @see Wx::ComboBox#set_string
+    # @see  Wx::ComboBox#set_string_selection 
+    # @param n [Integer]  The string position to select, starting from zero.
+    # @return [void]
+    def set_selection(n) end
+    alias_method :selection=, :set_selection
+    
+    # Sets the text for the combobox text field.
+    # 
+    # For normal, editable comboboxes with a text entry field calling this method will generate a {Wx::EVT_TEXT} event, consistently with {Wx::TextEntry#set_value} behaviour, use {Wx::TextEntry#change_value} if this is undesirable.
+    # For controls with {Wx::CB_READONLY} style the method behaves somewhat differently: the string must be in the combobox choices list (the check for this is case-insensitive) and {Wx::EVT_TEXT} is not generated in this case.
+    # @param text [String]  The text to set.
+    # @return [void]
+    def set_value(text) end
+    alias_method :value=, :set_value
+    
+    # Shows the list box portion of the combo box.
+    # 
+    # Currently this method is implemented in WXMSW, WXGTK and WXOSX/Cocoa.
+    # Notice that calling this function will generate a {Wx::EVT_COMBOBOX_DROPDOWN} event except under WXOSX where generation of this event is not supported at all.
+    # @return [void]
+    def popup; end
+    
+    # Hides the list box portion of the combo box.
+    # 
+    # Currently this method is implemented in WXMSW, WXGTK and WXOSX/Cocoa.
+    # Notice that calling this function will generate a {Wx::EVT_COMBOBOX_CLOSEUP} event except under WXOSX where generation of this event is not supported at all.
+    # @return [void]
+    def dismiss; end
+    
+    # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
+    # 
+    # The position of the current selection.
+    # @see Wx::ComboBox#set_selection
+    # @see  Wx::ComboBox#get_string_selection 
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Gets the current selection span.
+    # 
+    # If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other {Wx::TextCtrl} methods but don't necessarily represent the correct indices into the string returned by {Wx::ComboBox#get_value} for multiline controls under Windows (at least,) you should use {Wx::ComboBox#get_string_selection} to get the selected text.
+    # @return [Array(Integer,Integer)]
+    def get_text_selection_range; end
+    alias_method :text_selection_range, :get_text_selection_range
+    
+    # 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 [Boolean]  Whether search is case sensitive (default is not).
+    # @return [Integer]
+    def find_string(string, caseSensitive=false) end
+    
+    # Returns the label of the item with the given index.
+    # 
+    # The index must be valid, i.e. less than the value returned by {Wx::ComboBox#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
+    # 
+    # The label of the item.
+    # @param n [Integer]  The zero-based index.
+    # @return [String]
+    def get_string(n) end
+    alias_method :string, :get_string
+    
+    # Returns the label of the selected item or an empty string if no item is selected.
+    # 
+    # 
+    # @see Wx::ComboBox#get_selection 
+    # @return [String]
+    def get_string_selection; end
+    alias_method :string_selection, :get_string_selection
+    
+    # Changes the text of the specified combobox item.
+    # 
+    # Notice that if the item is the currently selected one, i.e. if its text is displayed in the text part of the combobox, then the text is also replaced with the new text.
+    # @param n [Integer] 
+    # @param text [String] 
+    # @return [void]
+    def set_string(n, text) end
+    
+    # Returns the number of items in the control.
+    # 
+    # 
+    # @see Wx::ComboBox#is_empty 
+    # @return [Integer]
+    def get_count; end
+    alias_method :count, :get_count
+    
+  end # ComboBox
+  
+
+end