Class: Wx::FileDialogCustomize

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/file_dialog_customize_hook.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Used with FileDialogCustomizeHook to add custom controls to FileDialog.

An object of this class is passed to Wx::FileDialogCustomizeHook#add_custom_controls to allow it to actually add controls to the dialog. The pointers returned by the functions of this class belong to wxWidgets and should not be deleted by the application, just as Window-derived objects (even if these controls do not inherit from Window). These pointers become invalid when Wx::FileDialog#show_modal returns, and the dialog containing them is destroyed, and the latest point at which they can be still used is when Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls is called.

Category: Common Dialogs

See Also:

Requires:

  • USE_FILEDLG

Instance Method Summary collapse

Instance Method Details

#add_button(label) ⇒ Wx::FileDialogButton

Add a button with the specified label.

Parameters:

  • label (String)

Returns:



118
 
# File 'lib/wx/doc/gen/file_dialog_customize_hook.rb', line 118

def add_button(label) end

#add_check_box(label) ⇒ Wx::FileDialogCheckBox

Add a checkbox with the specified label.

Parameters:

  • label (String)

Returns:



123
 
# File 'lib/wx/doc/gen/file_dialog_customize_hook.rb', line 123

def add_check_box(label) end

#add_choice(strings) ⇒ Wx::FileDialogChoice

Add a read-only combobox with the specified contents.

The combobox doesn’t have any initial selection, i.e. Wx::FileDialogChoice#get_selection returns NOT_FOUND, if some item must be selected, use Wx::FileDialogChoice#set_selection explicitly to do it.

Parameters:

  • strings (Array<String>) —

    A non-NULL pointer to an array of n strings.

Returns:



138
 
# File 'lib/wx/doc/gen/file_dialog_customize_hook.rb', line 138

def add_choice(strings) end

#add_radio_button(label) ⇒ Wx::FileDialogRadioButton

Add a radio button with the specified label.

The first radio button added will be initially checked. All the radio buttons added immediately after it will become part of the same radio group and will not be checked, but checking any one of them later will uncheck the first button and all the other ones. If two consecutive but distinct radio groups are required, #add_static_text with an empty label can be used to separate them.

Parameters:

  • label (String)

Returns:



131
 
# File 'lib/wx/doc/gen/file_dialog_customize_hook.rb', line 131

def add_radio_button(label) end

#add_static_text(label) ⇒ Wx::FileDialogStaticText

Add a static text with the given contents.

The contents of the static text can be updated later, i.e. it doesn’t need to be actually static.

Parameters:

  • label (String)

Returns:



153
 
# File 'lib/wx/doc/gen/file_dialog_customize_hook.rb', line 153

def add_static_text(label) end

#add_text_ctrl(label = ('')) ⇒ Wx::FileDialogTextCtrl

Add a text control with an optional label preceding it.

Unlike all the other functions for adding controls, the label parameter here doesn’t specify the contents of the text control itself, but rather the label appearing before it. Unlike static controls added by #add_static_text, this label is guaranteed to be immediately adjacent to it. If label is empty, no label is created.

Parameters:

  • label (String) (defaults to: (''))

Returns:



146
 
# File 'lib/wx/doc/gen/file_dialog_customize_hook.rb', line 146

def add_text_ctrl(label=('')) end