wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,11 +7,12 @@
 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
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -25,7 +26,7 @@ module Wx
   # 
   # - {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
+  # ### 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:
@@ -36,15 +37,13 @@ module Wx
   # 
   # - {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_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
+  # 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
@@ -52,12 +51,14 @@ module Wx
   # @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=((CONST Wx::STRING *) 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] 
@@ -71,6 +72,7 @@ module Wx
     #   @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] 
@@ -90,6 +92,7 @@ module Wx
     # @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 NULL.
@@ -105,6 +108,7 @@ module Wx
     # @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 NULL.
@@ -120,24 +124,32 @@ module Wx
     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}.
-    # Under wxMSW, this function always returns 0 if the combobox doesn't have the focus.
+    # 
+    # <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
@@ -148,9 +160,9 @@ module Wx
     # @param to [Integer] 
     # @return [void]
     def set_text_selection_range(from, to) end
-    alias_method :text_selection_range=, :set_text_selection_range
     
     # 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 
@@ -160,6 +172,7 @@ module Wx
     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.
@@ -168,18 +181,21 @@ module Wx
     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.
+    # 
+    # 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.
+    # 
+    # 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 
@@ -188,12 +204,14 @@ module Wx
     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).
@@ -201,6 +219,7 @@ module Wx
     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.
@@ -210,12 +229,14 @@ module Wx
     alias_method :string, :get_string
     
     # Gets the text currently selected in the control.
+    # 
     # If there is no selection, the returned string is empty.
     # @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] 
@@ -224,6 +245,7 @@ module Wx
     
     # Returns the number of items in the control.
     # 
+    # 
     # @see Wx::ComboBox#is_empty 
     # @return [Integer]
     def get_count; end