# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # The base class for all {Wx::FileDialog} custom controls. # # Unlike normal controls, inheriting from {Wx::Window}, custom controls in {Wx::FileDialog} are not actual windows, but they do provide some window-like operations, and can be disabled or hidden, just as the windows are. # Also, similarly to the normal windows, objects of this and derived classes belong to wxWidgets and must not be deleted by the application code. # Unlike windows, custom controls cannot be created directly, but can only be returned from {Wx::FileDialogCustomize} functions that are specifically provided for creating them. # # @wxrb_require USE_FILEDLG class FileDialogCustomControl < EvtHandler # Show or hide this control. # @param show [Boolean] # @return [void] def show(show=true) end # Hide this control. # # This is equivalent to Show(false). # @return [void] def hide; end # Enable or disable this control. # @param enable [Boolean] # @return [void] def enable(enable=true) end # Disable this control. # # This is equivalent to Enable(false). # @return [void] def disable; end end # FileDialogCustomControl # Represents a custom button inside {Wx::FileDialog}. # # Objects of this class can only be created by {Wx::FileDialogCustomize#add_button}. # It is possible to bind to {Wx::EVT_BUTTON} events on this object, which will be generated when the button is clicked. # See {Wx::FileDialogCustomControl} for more information. # # @wxrb_require USE_FILEDLG class FileDialogButton < FileDialogCustomControl end # FileDialogButton # Represents a custom checkbox inside {Wx::FileDialog}. # # Objects of this class can only be created by {Wx::FileDialogCustomize#add_check_box}. # It is possible to bind to {Wx::EVT_CHECKBOX} events on this object, which will be generated when the checkbox is clicked. # See {Wx::FileDialogCustomControl} for more information. # # @wxrb_require USE_FILEDLG class FileDialogCheckBox < FileDialogCustomControl # Return true if the checkbox is checked. # @return [Boolean] def get_value; end alias_method :value, :get_value # Check or uncheck the checkbox. # @param value [Boolean] # @return [void] def set_value(value) end alias_method :value=, :set_value end # FileDialogCheckBox # Represents a custom radio button inside {Wx::FileDialog}. # # Objects of this class can only be created by {Wx::FileDialogCustomize#add_radio_button}. # It is possible to bind to {Wx::EVT_RADIOBUTTON} events on this object, which will be generated when the radio button is selected. # See {Wx::FileDialogCustomControl} for more information. # # @wxrb_require USE_FILEDLG class FileDialogRadioButton < FileDialogCustomControl # Return true if the radio button is selected. # @return [Boolean] def get_value; end alias_method :value, :get_value # Select the value of the radio button. # # Using false for value is not supported, this argument only exists for consistency with {Wx::RadioButton#set_value}. # @param value [Boolean] # @return [void] def set_value(value) end alias_method :value=, :set_value end # FileDialogRadioButton # Represents a custom read-only combobox inside {Wx::FileDialog}. # # Objects of this class can only be created by {Wx::FileDialogCustomize#add_choice}. # It is possible to bind to {Wx::EVT_CHOICE} events on this object, which will be generated when the selection in the combobox changes. # See {Wx::FileDialogCustomControl} for more information. # # @wxrb_require USE_FILEDLG class FileDialogChoice < FileDialogCustomControl # Return the index of the selected item, possibly {Wx::NOT_FOUND}. # @return [Integer] def get_selection; end alias_method :selection, :get_selection # Set the selection to the item with the given index. # # Using {Wx::NOT_FOUND} for n is not supported, once a selection is made it cannot be undone. # @param n [Integer] # @return [void] def set_selection(n) end alias_method :selection=, :set_selection end # FileDialogChoice # Represents a custom text control inside {Wx::FileDialog}. # # Objects of this class can only be created by {Wx::FileDialogCustomize#add_text_ctrl}. # Objects of this class don't generate any events currently. # See {Wx::FileDialogCustomControl} for more information. # # @wxrb_require USE_FILEDLG class FileDialogTextCtrl < FileDialogCustomControl # Get the current value entered into the control. # @return [String] def get_value; end alias_method :value, :get_value # Set the current control value. # @param text [String] # @return [void] def set_value(text) end alias_method :value=, :set_value end # FileDialogTextCtrl # Represents a custom static text inside {Wx::FileDialog}. # # Objects of this class can only be created by {Wx::FileDialogCustomize#add_static_text}. # Objects of this class don't generate any events. # See {Wx::FileDialogCustomControl} for more information. # # @wxrb_require USE_FILEDLG class FileDialogStaticText < FileDialogCustomControl # Set the text shown in the label. # # Any ampersands in the text will be escaped, there is no need to do it manually, e.g. using {Wx::Control.escape_mnemonics}. # @param text [String] # @return [void] def set_label_text(text) end alias_method :label_text=, :set_label_text end # FileDialogStaticText end