Class: Wx::RTC::RichTextFieldType

Inherits:

Object

• Object
• Object
• Wx::RTC::RichTextFieldType

Defined in:

lib/wx/doc/gen/rtc/rich_text_buffer.rb

Overview

The base class for custom field types.

Each type definition handles one field type. Override functions to provide drawing, layout, updating and property editing functionality for a field. Register field types on application initialisation with the static function Wx::RTC::RichTextBuffer.add_field_type. They will be deleted automatically on application exit.

Category: Rich Text

See Also:

• RichTextFieldTypeStandard
• RichTextField
• RichTextCtrl

Requires:

• USE_RICHTEXT

Direct Known Subclasses

RichTextFieldTypeStandard

Instance Method Summary

• #can_edit_properties(obj) ⇒ Boolean (also: #can_edit_properties?)

  Returns true if we can edit the object's properties via a GUI.

• #copy(fieldType) ⇒ void
• #draw(obj, dc, context, range, selection, rect, descent, style) ⇒ Boolean

  Draw the item, within the given range.

• #edit_properties(obj, parent, buffer) ⇒ Boolean

  Edits the object's properties via a GUI.

• #get_name ⇒ String (also: #name)

  Returns the field type name.

• #get_properties_menu_label(obj) ⇒ String (also: #properties_menu_label)

  Returns the label to be used for the properties context menu item.

• #get_range_size(obj, range, size, descent, dc, context, flags, position = (Wx::Point.new(0, 0)), parentSize = Wx::DEFAULT_SIZE, partialExtents = nil) ⇒ Array(Boolean,Integer) (also: #range_size)

  Returns the object size for the given range.

• #initialize(*args) ⇒ RichTextFieldType constructor

  A new instance of RichTextFieldType.

• #is_top_level(obj) ⇒ Boolean (also: #top_level?)

  Returns true if this object is top-level, i.e.

• #layout(obj, dc, context, rect, parentRect, style) ⇒ Boolean

  Lay the item out at the specified position with the given size constraint.

• #set_name(name) ⇒ void (also: #name=)

  Sets the field type name.

• #update_field(buffer, obj) ⇒ Boolean

  Update the field.

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(name = ('')) ⇒ Wx::RTC::RichTextFieldType #initialize(fieldType) ⇒ Wx::RTC::RichTextFieldType

Returns a new instance of RichTextFieldType.

Overloads:

• #initialize(name = ('')) ⇒ Wx::RTC::RichTextFieldType

  Creates a field type definition.

  Parameters:

  • name (String) (defaults to: (''))
• #initialize(fieldType) ⇒ Wx::RTC::RichTextFieldType

  Copy constructor.

  Parameters:

  • fieldType (Wx::RTC::RichTextFieldType)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 751

def initialize(*args) end

Instance Method Details

#can_edit_properties(obj) ⇒ Boolean Also known as: can_edit_properties?

Returns true if we can edit the object's properties via a GUI.

Parameters:

• obj (Wx::RTC::RichTextField)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 803

def can_edit_properties(obj) end

#copy(fieldType) ⇒ void

This method returns an undefined value.

Parameters:

• fieldType (Wx::RTC::RichTextFieldType)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 755

def copy(fieldType) end

#draw(obj, dc, context, range, selection, rect, descent, style) ⇒ Boolean

Draw the item, within the given range.

Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)

Parameters:

• obj (Wx::RTC::RichTextField)
• dc (Wx::DC)
• context (Wx::RTC::RichTextDrawingContext)
• range (Range)
• selection (Wx::RTC::RichTextSelection)
• rect (Wx::Rect)
• descent (Integer)
• style (Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 769

def draw(obj, dc, context, range, selection, rect, descent, style) end

#edit_properties(obj, parent, buffer) ⇒ Boolean

Edits the object's properties via a GUI.

Parameters:

• obj (Wx::RTC::RichTextField)
• parent (Wx::Window)
• buffer (Wx::RTC::RichTextBuffer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 811

def edit_properties(obj, parent, buffer) end

#get_name ⇒ String Also known as: name

Returns the field type name.

There should be a unique name per field type object.

Returns:

• (String)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 845

def get_name; end

#get_properties_menu_label(obj) ⇒ String Also known as: properties_menu_label

Returns the label to be used for the properties context menu item.

Parameters:

• obj (Wx::RTC::RichTextField)

Returns:

• (String)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 816

def get_properties_menu_label(obj) end

#get_range_size(obj, range, size, descent, dc, context, flags, position = (Wx::Point.new(0, 0)), parentSize = Wx::DEFAULT_SIZE, partialExtents = nil) ⇒ Array(Boolean,Integer) Also known as: range_size

Returns the object size for the given range.

Returns false if the range is invalid for this object.

Parameters:

• obj (Wx::RTC::RichTextField)
• range (Range)
• size (Array(Integer, Integer), Wx::Size)
• descent (Integer)
• dc (Wx::ReadOnlyDC)
• context (Wx::RTC::RichTextDrawingContext)
• flags (Integer)
• position (Array(Integer, Integer), Wx::Point) (defaults to: (Wx::Point.new(0, 0)))
• parentSize (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
• partialExtents (Array, nil) (defaults to: nil)

Returns:

• (Array(Boolean,Integer))

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 797

def get_range_size(obj, range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end

#is_top_level(obj) ⇒ Boolean Also known as: top_level?

Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.

Parameters:

• obj (Wx::RTC::RichTextField)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 830

def is_top_level(obj) end

#layout(obj, dc, context, rect, parentRect, style) ⇒ Boolean

Lay the item out at the specified position with the given size constraint.

Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).

Parameters:

• obj (Wx::RTC::RichTextField)
• dc (Wx::ReadOnlyDC)
• context (Wx::RTC::RichTextDrawingContext)
• rect (Wx::Rect)
• parentRect (Wx::Rect)
• style (Integer)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 781

def layout(obj, dc, context, rect, parentRect, style) end

#set_name(name) ⇒ void Also known as: name=

This method returns an undefined value.

Sets the field type name.

There should be a unique name per field type object.

Parameters:

• name (String)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 838

def set_name(name) end

#update_field(buffer, obj) ⇒ Boolean

Update the field.

This would typically expand the field to its value, if this is a dynamically changing and/or composite field.

Parameters:

• buffer (Wx::RTC::RichTextBuffer)
• obj (Wx::RTC::RichTextField)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_buffer.rb', line 825

def update_field(buffer, obj) end