Class: Wx::PG::PGTextCtrlEditor

Inherits:

PGEditor

• Object
• Object
• PGEditor
• Wx::PG::PGTextCtrlEditor

Defined in:

lib/wx/doc/gen/pg/pg_editor.rb

Overview

Requires:

• USE_PROPGRID

Direct Known Subclasses

PGSpinCtrlEditor, PGTextCtrlAndButtonEditor

Class Method Summary

• .get_text_ctrl_value_from_control(variant, property, ctrl) ⇒ Boolean
• .on_text_ctrl_event(propgrid, property, ctrl, event) ⇒ Boolean

Instance Method Summary

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

  Instantiates editor controls.

• #get_name ⇒ String (also: #name)

  Returns pointer to the name of the editor.

• #get_value_from_control(variant, property, ctrl) ⇒ Boolean (also: #value_from_control)

  Returns value from control, via parameter variant.

• #initialize ⇒ Wx::PG::PGTextCtrlEditor constructor
• #on_event(propgrid, property, wnd_primary, event) ⇒ Boolean

  Handles events.

• #on_focus(property, wnd) ⇒ void

  Extra processing when control gains focus.

• #set_control_string_value(property, ctrl, txt) ⇒ void

  Sets control’s value specifically from string.

• #update_control(property, ctrl) ⇒ void

  Loads value from property to the control.

Methods inherited from PGEditor

#can_contain_custom_image, #delete_item, #draw_value, #insert_item, #set_control_appearance, #set_control_int_value, #set_value_to_unspecified

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::PG::PGTextCtrlEditor

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

def initialize; end

Class Method Details

.get_text_ctrl_value_from_control(variant, property, ctrl) ⇒ Boolean

Parameters:

• variant (Wx::Variant)
• property (Wx::PG::PGProperty)
• ctrl (Wx::Window)

Returns:

• (Boolean)

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

def self.get_text_ctrl_value_from_control(variant, property, ctrl) end

.on_text_ctrl_event(propgrid, property, ctrl, event) ⇒ Boolean

Parameters:

• propgrid (Wx::PG::PropertyGrid)
• property (Wx::PG::PGProperty)
• ctrl (Wx::Window)
• event (Wx::Event)

Returns:

• (Boolean)

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

def self.on_text_ctrl_event(propgrid, property, ctrl, event) end

Instance Method Details

#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:

• propgrid (Wx::PG::PropertyGrid) —

  Wx::PG::PropertyGrid to which the property belongs (use as parent for control).

• property (Wx::PG::PGProperty) —

  Property for which this method is called.

• pos (Array(Integer, Integer), Wx::Point) —

  Position, inside Wx::PG::PropertyGrid, to create control(s) to.

• size (Array(Integer, Integer), Wx::Size) —

  Initial size for control(s).

Returns:

• (Wx::Window, Array<Wx::Window,Wx::Window>)

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

def create_controls(propgrid, property, pos, size) 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)

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

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:

• variant (Wx::Variant)
• property (Wx::PG::PGProperty)
• ctrl (Wx::Window)

Returns:

• (Boolean)

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

def get_value_from_control(variant, property, ctrl) 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:

• propgrid (Wx::PG::PropertyGrid)
• property (Wx::PG::PGProperty)
• wnd_primary (Wx::Window)
• event (Wx::Event)

Returns:

• (Boolean)

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

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

#on_focus(property, wnd) ⇒ void

This method returns an undefined value.

Extra processing when control gains focus.

For example, TextCtrl based controls should select all text.

Parameters:

• property (Wx::PG::PGProperty)
• wnd (Wx::Window)

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

def on_focus(property, wnd) end

#set_control_string_value(property, ctrl, txt) ⇒ void

This method returns an undefined value.

Sets control’s value specifically from string.

Parameters:

• property (Wx::PG::PGProperty)
• ctrl (Wx::Window)
• txt (String)

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

def set_control_string_value(property, ctrl, txt) end

#update_control(property, ctrl) ⇒ void

This method returns an undefined value.

Loads value from property to the control.

Parameters:

• property (Wx::PG::PGProperty)
• ctrl (Wx::Window)

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

def update_control(property, ctrl) end