wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,662 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  CC_SPECIAL_DCLICK = 256
+  
+  # 
+  # 
+  CC_STD_BUTTON = 512
+  
+  # A combo control is a generic combobox that allows totally custom popup.
+  # 
+  # In addition it has other customization features. For instance, position and size of the dropdown button can be changed.
+  # 
+  # ## Setting Custom Popup for wxComboCtrl
+  # {Wx::ComboCtrl} needs to be told somehow which control to use and this is done by {Wx::ComboCtrl#set_popup_control}. However, we need something more than just a {Wx::Control} in this method as, for example, we need to call SetStringValue("initial text value") and {Wx::Control} doesn't have such method. So we also need a {Wx::ComboPopup} which is an interface which must be implemented by a control to be usable as a popup.
+  # We couldn't derive {Wx::ComboPopup} from {Wx::Control} as this would make it impossible to have a class deriving from a wxWidgets control and from it, so instead it is just a mix-in.
+  # Here's a minimal sample of {Wx::ListView} popup:
+  # 
+  # ```ruby
+  # class ListViewComboPopup < Wx::ListView
+  # 
+  #   include Wx::ComboPopup
+  #   
+  #   # Allow only default ctor
+  #   def initialize
+  #     # call default control ctor; need to call Wx::ListView#create later
+  #     super
+  #   end
+  #   
+  #   # Initialize member variables
+  #   def init
+  #     @value = -1
+  #   end
+  #   
+  #   # Create popup control
+  #   def create(parent)
+  #     # need to finish creating the list view here
+  #     # as calling super here would just call Wx::ComboPopup#create and not Wx::ListView#create
+  #     # we need to use Ruby magic
+  #     wx_lv_create = (Wx::ListView.instance_method :create).bind(self)
+  #     wx_lv_create.call(parent, 1, [0,0], Wx::DEFAULT_SIZE)
+  #     evt_motion :on_mouse_move
+  #     evt_left_up :on_mouse_click
+  #     end
+  #   
+  #   # Return pointer to the created control
+  #   def get_control
+  #     self
+  #   end
+  #   
+  #   def lv_find_item(*args)
+  #     unless @wx_lv_find_item
+  #     @wx_lv_find_item = (Wx::ListView.instance_method :find_item).bind(self)
+  #     end
+  #     @wx_lv_find_item.call(*args)
+  #   end
+  #   protected :lv_find_item
+  #   
+  #   # Translate string into a list selection
+  #   def set_string_value(s)
+  #     n = lv_find_item(-1, s)
+  #     if n >= 0 && n < get_item_count
+  #       select(n)
+  #       @value = n
+  #     end
+  #   end
+  #   
+  #   # Get list selection as a string
+  #   def get_string_value
+  #     return get_item_text(@value) if @value >= 0
+  #     ''
+  #   end
+  #   
+  #   # Do mouse hot-tracking (which is typical in list popups)
+  #   def on_mouse_move(event)
+  #     # Move selection to cursor ...
+  #   end
+  #   
+  #   # On mouse left up, set the value and close the popup
+  #   def on_mouse_click(_event)
+  #     @value = get_first_selected
+  #     
+  #     # Send event as well ...
+  #     
+  #     dismiss
+  #   end
+  # 
+  # end
+  # ```
+  # 
+  # Here's how you would create and populate it in a dialog constructor:
+  # 
+  # ```ruby
+  #   comboCtrl = Wx::ComboCtrl.new(self, Wx::ID_ANY, '')
+  #   
+  #   popupCtrl = ListViewComboPopup.new
+  #   
+  #   # It is important to call #set_popup_control as soon as possible
+  #   comboCtrl.set_popup_control(popupCtrl)
+  #   
+  #   # Populate using Wx::ListView methods
+  #   popupCtrl.insert_item((popupCtrl.item_count, 'First Item')
+  #   popupCtrl.insert_item((popupCtrl.item_count, 'Second Item')
+  #   popupCtrl.insert_item((popupCtrl.item_count, 'Third Item')
+  # ```
+  # 
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CB_READONLY}: Text will not be editable. 
+  # 
+  # - {Wx::CB_SORT}: Sorts the entries in the list alphabetically. 
+  # 
+  # - {Wx::TE_PROCESS_ENTER}: The control will generate the event {Wx::EVT_TEXT_ENTER} (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows only. 
+  # 
+  # - {Wx::CC_SPECIAL_DCLICK}: Double-clicking triggers a call to popup's OnComboDoubleClick. Actual behaviour is defined by a derived class. For instance, {Wx::OwnerDrawnComboBox} will cycle an item. This style only applies if {Wx::CB_READONLY} is used as well. 
+  # 
+  # - {Wx::CC_STD_BUTTON}: Drop button will behave more like a standard push button. 
+  # 
+  # ### 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_text}(id, meth = nil, &block): Process a {Wx::EVT_TEXT} event, when the text changes. 
+  # 
+  # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combo control. 
+  # 
+  # - {Wx::EvtHandler#evt_combobox_dropdown}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX_DROPDOWN} event, which is generated when the popup window is shown (drops down). 
+  # 
+  # - {Wx::EvtHandler#evt_combobox_closeup}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX_CLOSEUP} event, which is generated when the popup window of the combo control disappears (closes up). You should avoid adding or deleting items in this event. 
+  # 
+  # 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::ComboBox
+  # @see  Wx::Choice
+  # @see  Wx::OwnerDrawnComboBox
+  # @see  Wx::ComboPopup
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  # @wxrb_require USE_COMBOCTRL
+  class ComboCtrl < Control
+  
+    include Wx::TextEntry
+  
+    # @overload set_margins(pt)
+    #   Attempts to set the control margins.
+    #   
+    #   When margins are given as {Wx::Point}, x indicates the left and y the top margin. Use -1 to indicate that an existing value should be used.
+    #   true if setting of all requested margins was successful.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Boolean]
+    # @overload set_margins(left, top=-1)
+    #   Attempts to set the control margins.
+    #   
+    #   When margins are given as {Wx::Point}, x indicates the left and y the top margin. Use -1 to indicate that an existing value should be used.
+    #   true if setting of all requested margins was successful.
+    #   @param left [Integer] 
+    #   @param top [Integer] 
+    #   @return [Boolean]
+    def set_margins(*args) end
+    alias_method :margins=, :set_margins
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::ComboCtrl]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Constructor, creating and showing a combo control.
+    #   
+    #   
+    #   @see Wx::ComboCtrl#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. 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 style [Integer]  Window style. See {Wx::ComboCtrl}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::ComboCtrl]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a combo control.
+    #   
+    #   
+    #   @see Wx::ComboCtrl#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. 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 style [Integer]  Window style. See {Wx::ComboCtrl}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::ComboCtrl] win new instance
+    #   @return [Wx::ComboCtrl]
+    def initialize(*args) end
+    
+    # Copies the selected text to the clipboard.
+    # @return [void]
+    def copy; end
+    
+    # Creates the combo control for two-step construction.
+    # 
+    # Derived classes should call or replace this function. See {Wx::ComboCtrl#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 style [Integer] 
+    # @param validator [Wx::Validator] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR) end
+    
+    # Copies the selected text to the clipboard and removes the selection.
+    # @return [void]
+    def cut; end
+    
+    # Dismisses the popup window.
+    # 
+    # Notice that calling this function will generate a {Wx::EVT_COMBOBOX_CLOSEUP} event.
+    # @return [void]
+    def dismiss; end
+    
+    # Enables or disables popup animation, if any, depending on the value of the argument.
+    # @param enable [Boolean] 
+    # @return [void]
+    def enable_popup_animation(enable=true) end
+    
+    # Returns true if given key combination should toggle the popup.
+    # @param event [Wx::KeyEvent] 
+    # @return [Boolean]
+    def is_key_popup_toggle(event) end
+    alias_method :key_popup_toggle?, :is_key_popup_toggle
+    
+    # Prepare background of combo control or an item in a dropdown list in a way typical on platform.
+    # 
+    # This includes painting the focus/disabled background and setting the clipping region.
+    # Unless you plan to paint your own focus indicator, you should always call this in your {Wx::ComboPopup::PaintComboControl} implementation. In addition, it sets pen and text colour to what looks good and proper against the background.
+    # flags: {Wx::RendererNative} flags: {Wx::CONTROL_ISSUBMENU}: is drawing a list item instead of combo control {Wx::CONTROL_SELECTED}: list item is selected {Wx::CONTROL_DISABLED}: control/item is disabled
+    # @param dc [Wx::DC] 
+    # @param rect [Wx::Rect] 
+    # @param flags [Integer] 
+    # @return [void]
+    def prepare_background(dc, rect, flags) end
+    
+    # Returns true if focus indicator should be drawn in the control.
+    # @return [Boolean]
+    def should_draw_focus; end
+    
+    # Returns disabled button bitmap that has been set with {Wx::ComboCtrl#set_button_bitmaps}.
+    # 
+    # The disabled state bitmap.
+    # @return [Wx::Bitmap]
+    def get_bitmap_disabled; end
+    alias_method :bitmap_disabled, :get_bitmap_disabled
+    
+    # Returns button mouse hover bitmap that has been set with {Wx::ComboCtrl#set_button_bitmaps}.
+    # 
+    # The mouse hover state bitmap.
+    # @return [Wx::Bitmap]
+    def get_bitmap_hover; end
+    alias_method :bitmap_hover, :get_bitmap_hover
+    
+    # Returns default button bitmap that has been set with {Wx::ComboCtrl#set_button_bitmaps}.
+    # 
+    # The normal state bitmap.
+    # @return [Wx::Bitmap]
+    def get_bitmap_normal; end
+    alias_method :bitmap_normal, :get_bitmap_normal
+    
+    # Returns depressed button bitmap that has been set with {Wx::ComboCtrl#set_button_bitmaps}.
+    # 
+    # The depressed state bitmap.
+    # @return [Wx::Bitmap]
+    def get_bitmap_pressed; end
+    alias_method :bitmap_pressed, :get_bitmap_pressed
+    
+    # Returns current size of the dropdown button.
+    # @return [Wx::Size]
+    def get_button_size; end
+    alias_method :button_size, :get_button_size
+    
+    # Returns custom painted area in control.
+    # 
+    # 
+    # @see Wx::ComboCtrl#set_custom_paint_width. 
+    # @return [Integer]
+    def get_custom_paint_width; end
+    alias_method :custom_paint_width, :get_custom_paint_width
+    
+    # Returns the current hint string.
+    # 
+    # See {Wx::ComboCtrl#set_hint} for more information about hints.
+    # @return [String]
+    def get_hint; end
+    alias_method :hint, :get_hint
+    
+    # Returns the insertion point for the combo control's text field.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Under Windows, this function always returns 0 if the combo control doesn't have the focus. 
+    # </p>
+    # </div>
+    # @return [Integer]
+    def get_insertion_point; end
+    alias_method :insertion_point, :get_insertion_point
+    
+    # Returns the last position in the combo control text field.
+    # @return [Integer]
+    def get_last_position; end
+    alias_method :last_position, :get_last_position
+    
+    # Returns the margins used by the control.
+    # 
+    # The x field of the returned point is the horizontal margin and the y field is the vertical one.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If given margin cannot be accurately determined, its value will be set to -1.
+    # </p>
+    # </div>
+    # @see Wx::ComboCtrl#set_margins
+    # @return [Wx::Point]
+    def get_margins; end
+    alias_method :margins, :get_margins
+    
+    # Returns current popup interface that has been set with {Wx::ComboCtrl#set_popup_control}.
+    # @return [Wx::ComboPopup]
+    def get_popup_control; end
+    alias_method :popup_control, :get_popup_control
+    
+    # Returns popup window containing the popup control.
+    # @return [Wx::Window]
+    def get_popup_window; end
+    alias_method :popup_window, :get_popup_window
+    
+    # Get the text control which is part of the combo control.
+    # @return [Wx::TextCtrl]
+    def get_text_ctrl; end
+    alias_method :text_ctrl, :get_text_ctrl
+    
+    # Returns area covered by the text field (includes everything except borders and the dropdown button).
+    # @return [Wx::Rect]
+    def get_text_rect; end
+    alias_method :text_rect, :get_text_rect
+    
+    # Returns text representation of the current value.
+    # 
+    # For writable combo control it always returns the value in the text field.
+    # @return [String]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Returns true if the popup is currently shown.
+    # @return [Boolean]
+    def is_popup_shown; end
+    alias_method :popup_shown?, :is_popup_shown
+    
+    # Returns true if the popup window is in the given state.
+    # 
+    # Possible values are:
+    # 
+    # {Wx::ComboCtrl::Hidden}
+    # Popup window is hidden.
+    # 
+    # {Wx::ComboCtrl::Animating}
+    # Popup window is being shown, but the popup animation has not yet finished.
+    # 
+    # {Wx::ComboCtrl::Visible}
+    # Popup window is fully visible.
+    # @param state [Integer] 
+    # @return [Boolean]
+    def is_popup_window_state(state) end
+    alias_method :popup_window_state?, :is_popup_window_state
+    
+    # Implement in a derived class to define what happens on dropdown button click.
+    # 
+    # Default action is to show the popup.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>If you implement this to do something else than show the popup, you must then also implement {Wx::ComboCtrl#do_set_popup_control} to always return nil. 
+    # </p>
+    # </div>
+    # @return [void]
+    def on_button_click; end
+    
+    # Pastes text from the clipboard to the text field.
+    # @return [void]
+    def paste; end
+    
+    # Shows the popup portion of the combo control.
+    # 
+    # Notice that calling this function will generate a {Wx::EVT_COMBOBOX_DROPDOWN} event.
+    # @return [void]
+    def popup; end
+    
+    # Removes the text between the two positions in the combo control text field.
+    # @param from [Integer]  The first position.
+    # @param to [Integer]  The last position.
+    # @return [void]
+    def remove(from, to) end
+    
+    # Replaces the text between two positions with the given text, in the combo control text field.
+    # @param from [Integer]  The first position.
+    # @param to [Integer]  The second position.
+    # @param text [String]  The text to insert.
+    # @return [void]
+    def replace(from, to, text) end
+    
+    # Sets custom dropdown button graphics.
+    # @param bmpNormal [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Default button image.
+    # @param pushButtonBg [Boolean]  If true, blank push button background is painted below the image.
+    # @param bmpPressed [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Depressed button image.
+    # @param bmpHover [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Button image when mouse hovers above it. This should be ignored on platforms and themes that do not generally draw different kind of button on mouse hover.
+    # @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Disabled button image.
+    # @return [void]
+    def set_button_bitmaps(bmpNormal, pushButtonBg=false, bmpPressed=(Wx::BitmapBundle.new()), bmpHover=(Wx::BitmapBundle.new()), bmpDisabled=(Wx::BitmapBundle.new())) end
+    alias_method :button_bitmaps=, :set_button_bitmaps
+    
+    # Sets size and position of dropdown button.
+    # @param width [Integer]  Button width. Value = 0 specifies default.
+    # @param height [Integer]  Button height. Value = 0 specifies default.
+    # @param side [Integer]  Indicates which side the button will be placed. Value can be {Wx::Direction::LEFT} or {Wx::Direction::RIGHT}.
+    # @param spacingX [Integer]  Horizontal spacing around the button. Default is 0.
+    # @return [void]
+    def set_button_position(width=-1, height=-1, side=Wx::Direction::RIGHT, spacingX=0) end
+    alias_method :button_position=, :set_button_position
+    
+    # Set width, in pixels, of custom painted area in control without {Wx::CB_READONLY} style.
+    # 
+    # In read-only {Wx::OwnerDrawnComboBox}, this is used to indicate area that is not covered by the focus rectangle.
+    # @param width [Integer] 
+    # @return [void]
+    def set_custom_paint_width(width) end
+    alias_method :custom_paint_width=, :set_custom_paint_width
+    
+    # Sets a hint shown in an empty unfocused combo control.
+    # 
+    # Notice that hints are known as cue banners under MSW or placeholder strings under macOS.
+    # @see Wx::TextEntry#set_hint
+    # @param hint [String] 
+    # @return [Boolean]
+    def set_hint(hint) end
+    alias_method :hint=, :set_hint
+    
+    # Sets the insertion point in the text field.
+    # @param pos [Integer]  The new insertion point.
+    # @return [void]
+    def set_insertion_point(pos) end
+    alias_method :insertion_point=, :set_insertion_point
+    
+    # Sets the insertion point at the end of the combo control text field.
+    # @return [void]
+    def set_insertion_point_end; end
+    
+    # Uses the given window instead of the default text control as the main window of the combo control.
+    # 
+    # By default, combo controls without {Wx::CB_READONLY} style create a {Wx::TextCtrl} which shows the current value and allows to edit it. This method allows to use some other window instead of this {Wx::TextCtrl}.
+    # This method can be called after creating the combo fully, however in this case a {Wx::TextCtrl} is unnecessarily created just to be immediately destroyed when it's replaced by a custom window. If you wish to avoid this, you can use the following approach, also shown in the combo sample:
+    # 
+    # ```ruby
+    #   # Create the combo control using its default ctor.
+    #   combo = Wx::ComboCtrl.new
+    #   
+    #   # Create the custom main control using its default ctor too.
+    #   main = SomeWindow.new
+    #   
+    #   # Set the custom main control before creating the combo.
+    #   combo.set_main_control(main)
+    #   
+    #   # And only create it now: Wx::TextCtrl won't be unnecessarily
+    #   # created because the combo already has a main window.
+    #   combo.create(panel, Wx::ID_ANY, '')
+    #   
+    #   # Finally create the main window itself, now that its parent was
+    #   # created.
+    #   main.create(combo, ...)
+    # ```
+    # 
+    # Note that when a custom main window is used, none of the methods of this class inherited from {Wx::TextEntry}, such as {Wx::ComboCtrl#set_value}, {Wx::ComboCtrl#replace}, {Wx::ComboCtrl#set_insertion_point} etc do anything and simply return.
+    # @param win [Wx::Window] 
+    # @return [void]
+    def set_main_control(win) end
+    alias_method :main_control=, :set_main_control
+    
+    # Set side of the control to which the popup will align itself.
+    # 
+    # Valid values are {Wx::Direction::LEFT}, {Wx::Direction::RIGHT} and 0. The default value 0 means that the most appropriate side is used (which, currently, is always {Wx::Direction::LEFT}).
+    # @param anchorSide [Integer] 
+    # @return [void]
+    def set_popup_anchor(anchorSide) end
+    alias_method :popup_anchor=, :set_popup_anchor
+    
+    # Set popup interface class derived from {Wx::ComboPopup}.
+    # 
+    # This method should be called as soon as possible after the control has been created, unless {Wx::ComboCtrl#on_button_click} has been overridden.
+    # @param popup [Wx::ComboPopup,nil] 
+    # @return [void]
+    def set_popup_control(popup) end
+    
+    # Extends popup size horizontally, relative to the edges of the combo control.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Popup minimum width may override arguments. It is up to the popup to fully take this into account. 
+    # </p>
+    # </div>
+    # @param extLeft [Integer]  How many pixel to extend beyond the left edge of the control. Default is 0.
+    # @param extRight [Integer]  How many pixel to extend beyond the right edge of the control. Default is 0.
+    # @return [void]
+    def set_popup_extents(extLeft, extRight) end
+    
+    # Sets preferred maximum height of the popup.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Value -1 indicates the default. 
+    # </p>
+    # </div>
+    # @param height [Integer] 
+    # @return [void]
+    def set_popup_max_height(height) end
+    alias_method :popup_max_height=, :set_popup_max_height
+    
+    # Sets minimum width of the popup.
+    # 
+    # If wider than combo control, it will extend to the left.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Value -1 indicates the default. Also, popup implementation may choose to ignore this. 
+    # </p>
+    # </div>
+    # @param width [Integer] 
+    # @return [void]
+    def set_popup_min_width(width) end
+    alias_method :popup_min_width=, :set_popup_min_width
+    
+    # Selects the text between the two positions, in the combo control text field.
+    # @param from [Integer]  The first position.
+    # @param to [Integer]  The second position.
+    # @return [void]
+    def set_selection(from, to) end
+    
+    # Sets the text for the text field without affecting the popup.
+    # 
+    # Thus, unlike {Wx::ComboCtrl#set_value}, it works equally well with combo control using {Wx::CB_READONLY} style.
+    # @param value [String] 
+    # @return [void]
+    def set_text(value) end
+    alias_method :text=, :set_text
+    
+    # Set a custom window style for the embedded {Wx::TextCtrl}.
+    # 
+    # Usually you will need to use this during two-step creation, just before {Wx::ComboCtrl#create}. For example:
+    # 
+    # ```ruby
+    #   comboCtrl = Wx::ComboCtrl.new
+    #   
+    #   # Let's make the text right-aligned
+    #   comboCtrl.set_text_ctrl_style(Wx::TE_RIGHT)
+    #   
+    #   comboCtrl.create(parent, Wx::ID_ANY, '')
+    # ```
+    # @param style [Integer] 
+    # @return [void]
+    def set_text_ctrl_style(style) end
+    alias_method :text_ctrl_style=, :set_text_ctrl_style
+    
+    # Sets the text for the combo control text field.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>For a combo control with {Wx::CB_READONLY} style the string must be accepted by the popup (for instance, exist in the dropdown list), otherwise the call to {Wx::ComboCtrl#set_value} is ignored. 
+    # </p>
+    # </div>
+    # @param value [String] 
+    # @return [void]
+    def set_value(value) end
+    alias_method :value=, :set_value
+    
+    # Changes value of the control as if user had done it by selecting an item from a combo box drop-down list.
+    # @param value [String] 
+    # @return [void]
+    def set_value_by_user(value) end
+    alias_method :value_by_user=, :set_value_by_user
+    
+    # Undoes the last edit in the text field.
+    # 
+    # Windows only.
+    # @return [void]
+    def undo; end
+    
+    # Enable or disable usage of an alternative popup window, which guarantees ability to focus the popup control, and allows common native controls to function normally.
+    # 
+    # This alternative popup window is usually a {Wx::Dialog}, and as such, when it is shown, its parent top-level window will appear as if the focus has been lost from it.
+    # @param enable [Boolean] 
+    # @return [void]
+    def use_alt_popup_window(enable=true) end
+    
+    # Returns features supported by {Wx::ComboCtrl}.
+    # 
+    # If needed feature is missing, you need to instead use {Wx::GenericComboCtrl}, which however may lack a native look and feel (but otherwise sports identical API).
+    # Value returned is a combination of the flags defined in {Wx::ComboCtrlFeatures}.
+    # @return [Integer]
+    def self.get_features; end
+    
+    
+    protected
+    
+    # This member function is not normally called in application code.
+    # 
+    # Instead, it can be implemented in a derived class to create a custom popup animation.
+    # The parameters are the same as those for {Wx::ComboCtrl#do_show_popup}.
+    # true if animation finishes before the function returns, false otherwise. In the latter case you need to manually call {Wx::ComboCtrl#do_show_popup} after the animation ends.
+    # @param rect [Wx::Rect] 
+    # @param flags [Integer] 
+    # @return [Boolean]
+    def animate_show(rect, flags) end
+    
+    # This member function is not normally called in application code.
+    # 
+    # Instead, it can be implemented in a derived class to return default {Wx::ComboPopup}, in case popup is nil.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>If you have implemented {Wx::ComboCtrl#on_button_click} to do something else than show the popup, then {Wx::ComboCtrl#do_set_popup_control} must always set popup to nil. 
+    # </p>
+    # </div>
+    # @param popup [Wx::ComboPopup,nil] 
+    # @return [void]
+    def do_set_popup_control(popup) end
+    
+    # This member function is not normally called in application code.
+    # 
+    # Instead, it must be called in a derived class to make sure popup is properly shown after a popup animation has finished (but only if {Wx::ComboCtrl#animate_show} did not finish the animation within its function scope).
+    # @param rect [Wx::Rect]  Position to show the popup window at, in screen coordinates.
+    # @param flags [Integer]  Combination of any of the following: {Wx::ComboCtrl::ShowAbove}, and {Wx::ComboCtrl::CanDeferShow}.
+    # @return [void]
+    def do_show_popup(rect, flags) end
+    
+  end # ComboCtrl
+  
+
+end