Class: Wx::PG::PGChoiceEditor

Inherits:
PGEditor show all
Defined in:
lib/wx/doc/gen/pg/pg_editor.rb

Overview

Requires:

  • USE_PROPGRID

Direct Known Subclasses

PGChoiceAndButtonEditor, PGComboBoxEditor

Instance Method Summary collapse

Methods inherited from PGEditor

#draw_value, #on_focus, #set_control_appearance

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::PG::PGChoiceEditor 



279
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 279

def initialize; end

Instance Method Details

#can_contain_custom_image ⇒ Boolean Also known as: can_contain_custom_image?

Returns true if control itself can contain the custom image.

Default implementation returns false.

Returns:

  • (Boolean) 


378
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 378

def can_contain_custom_image; end

#create_controls(propgrid, property, pos, size) ⇒ Wx::Window, Array<Wx::Window,Wx::Window>

Instantiates editor controls.

Remark:

- It is not necessary to call EvtHandler#bind for interesting editor events. All events from controls are automatically forwarded to Wx::PG::PGEditor#on_event and Wx::PG::PGProperty#on_event.

Parameters:

Returns:



296
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 296

def create_controls(propgrid, property, pos, size) end

#create_controls_base(propgrid, property, pos, sz, extraStyle) ⇒ Wx::Window

Parameters:

Returns:



387
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 387

def create_controls_base(propgrid, property, pos, sz, extraStyle) end

#delete_item(ctrl, index) ⇒ void

This method returns an undefined value.

Deletes item from existing control.

Default implementation does nothing.

Parameters:



372
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 372

def delete_item(ctrl, index) end

#get_name ⇒ String Also known as: name

Returns pointer to the name of the editor.

For example, Wx::PG_EDITOR_TEXT_CTRL has name “TextCtrl”. If you don’t need to access your custom editor by string name, then you do not need to implement this function.

Returns:

  • (String) 


340
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 340

def get_name; end

#get_value_from_control(variant, property, ctrl) ⇒ Boolean Also known as: value_from_control

Returns value from control, via parameter variant.

Usually ends up calling property’s StringToValue() or IntToValue(). Returns true if value was different.

Parameters:

Returns:

  • (Boolean) 


327
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 327

def get_value_from_control(variant, property, ctrl) end

#insert_item(ctrl, label, index) ⇒ Integer

Inserts item to existing control.

Index -1 means end of list. Default implementation does nothing. Returns index of item added.

Parameters:

  • ctrl (Wx::Window)
  • label (String)
  • index (Integer)

Returns:

  • (Integer) 


364
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 364

def insert_item(ctrl, label, index) end

#on_event(propgrid, property, wnd_primary, event) ⇒ Boolean

Handles events.

Returns true if value in control was modified (see Wx::PG::PGProperty#on_event for more information).

Remark:

Wx::PG::PropertyGrid will automatically unfocus the editor when EVT_TEXT_ENTER is received and when it results in property value being modified. This happens regardless of editor type (i.e. behaviour is same for any TextCtrl and ComboBox based editor).

Parameters:

Returns:

  • (Boolean) 


318
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 318

def on_event(propgrid, property, wnd_primary, event) end

#set_control_int_value(property, ctrl, value) ⇒ void

This method returns an undefined value.

Sets control’s value specifically from int (applies to choice etc.).

Parameters:



348
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 348

def set_control_int_value(property, ctrl, value) end

#set_control_string_value(property, ctrl, txt) ⇒ void

This method returns an undefined value.

Sets control’s value specifically from string.

Parameters:



355
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 355

def set_control_string_value(property, ctrl, txt) end

#set_value_to_unspecified(property, ctrl) ⇒ void

This method returns an undefined value.

Sets value in control to unspecified.

Parameters:



334
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 334

def set_value_to_unspecified(property, ctrl) end

#update_control(property, ctrl) ⇒ void

This method returns an undefined value.

Loads value from property to the control.

Parameters:



302
 
# File 'lib/wx/doc/gen/pg/pg_editor.rb', line 302

def update_control(property, ctrl) end