# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # PB_USE_TEXTCTRL = 2 # PB_SMALL = 32768 # Base abstract class for all pickers which support an auxiliary text control. # This class handles all positioning and sizing of the text control like a a horizontal {Wx::BoxSizer} would do, with the text control on the left of the picker button. # The proportion (see {Wx::Sizer} documentation for more info about proportion values) of the picker control defaults to 1 when there isn't a text control associated (see {Wx::PB_USE_TEXTCTRL} style) and to 0 otherwise. # === Styles # # This class supports the following styles: # # - {Wx::PB_USE_TEXTCTRL}: Creates a text control to the left of the picker which is completely managed by this {Wx::PickerBase} class. # # === # # Category: Picker Controls # @see Wx::ColourPickerCtrl # # class PickerBase < Control # @return [Wx::PickerBase] def initialize; end # Returns the margin (in pixel) between the picker and the text control. # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true. # @return [Integer] def get_internal_margin; end alias_method :internal_margin, :get_internal_margin # Returns the proportion value of the picker. # @return [Integer] def get_picker_ctrl_proportion; end alias_method :picker_ctrl_proportion, :get_picker_ctrl_proportion # Returns a pointer to the text control handled by this window or NULL if the {Wx::PB_USE_TEXTCTRL} style was not specified when this control was created. # The contents of the text control could be an invalid representation of the entity which can be chosen through the picker (e.g. when the user enters an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. {Wx::ColourPickerCtrl#get_colour}, {Wx::FilePickerCtrl#get_path}, etc). # @return [Wx::TextCtrl] def get_text_ctrl; end alias_method :text_ctrl, :get_text_ctrl # Returns the native implementation of the real picker control. # The returned control in the generic implementation of {Wx::FilePickerCtrl}, {Wx::DirPickerCtrl}, {Wx::FontPickerCtrl} and {Wx::ColourPickerCtrl} is a specialized {Wx::Button} class so that you can change its label doing, e.g.: # ```ruby # if Wx::PLATFORM == 'WXMSW' # # wxMSW is one of the platforms where the generic implementation # # of Wx::FilePickerCtrl is used... # # butt = myFilePickerCtrl.get_picker_ctrl # if butt # butt.set_label("Custom browse string") # end # end # ``` # @return [Wx::Control] def get_picker_ctrl; end alias_method :picker_ctrl, :get_picker_ctrl # Returns the proportion value of the text control. # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true. # @return [Integer] def get_text_ctrl_proportion; end alias_method :text_ctrl_proportion, :get_text_ctrl_proportion # Returns true if this window has a valid text control (i.e. if the {Wx::PB_USE_TEXTCTRL} style was given when creating this control). # @return [Boolean] def has_text_ctrl; end alias_method :has_text_ctrl?, :has_text_ctrl # Returns true if the picker control is growable. # @return [Boolean] def is_picker_ctrl_growable; end alias_method :picker_ctrl_growable?, :is_picker_ctrl_growable # Returns true if the text control is growable. # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true. # @return [Boolean] def is_text_ctrl_growable; end alias_method :text_ctrl_growable?, :is_text_ctrl_growable # Sets the margin (in pixel) between the picker and the text control. # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true. # @param margin [Integer] # @return [void] def set_internal_margin(margin) end alias_method :internal_margin=, :set_internal_margin # Sets the picker control as growable when grow is true. # @param grow [Boolean] # @return [void] def set_picker_ctrl_growable(grow=true) end alias_method :picker_ctrl_growable=, :set_picker_ctrl_growable # Sets the proportion value of the picker. # Look at the detailed description of {Wx::PickerBase} for more info. # @param prop [Integer] # @return [void] def set_picker_ctrl_proportion(prop) end alias_method :picker_ctrl_proportion=, :set_picker_ctrl_proportion # Sets the text control as growable when grow is true. # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true. # @param grow [Boolean] # @return [void] def set_text_ctrl_growable(grow=true) end alias_method :text_ctrl_growable=, :set_text_ctrl_growable # Sets the proportion value of the text control. # Look at the detailed description of {Wx::PickerBase} for more info. # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true. # @param prop [Integer] # @return [void] def set_text_ctrl_proportion(prop) end alias_method :text_ctrl_proportion=, :set_text_ctrl_proportion # @param text [Wx::TextCtrl] # @return [void] def set_text_ctrl(text) end alias_method :text_ctrl=, :set_text_ctrl # @param picker [Wx::Control] # @return [void] def set_picker_ctrl(picker) end alias_method :picker_ctrl=, :set_picker_ctrl # @return [void] def update_picker_from_text_ctrl; end # @return [void] def update_text_ctrl_from_picker; end end # PickerBase end