Class: Wx::RTC::RichTextFieldTypeStandard

Inherits:

RichTextFieldType

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

Defined in:

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

Overview

A field type that can handle fields with text or bitmap labels, with a small range of styles for implementing rectangular fields and fields that can be used for start and end tags.

The border, text and background colours can be customised; the default is white text on a black background. The following display styles can be used.

Styles

This class supports the following styles:

• RICHTEXT_FIELD_STYLE_COMPOSITE: Creates a composite field; you will probably need to derive a new class to implement UpdateField.

• RICHTEXT_FIELD_STYLE_RECTANGLE: Shows a rounded rectangle background.

• RICHTEXT_FIELD_STYLE_NO_BORDER: Suppresses the background and border; mostly used with a bitmap label.

• RICHTEXT_FIELD_STYLE_START_TAG: Shows a start tag background, with the pointy end facing right.

• RICHTEXT_FIELD_STYLE_END_TAG: Shows an end tag background, with the pointy end facing left.

Category: Rich Text

See Also:

• RichTextFieldType
• RichTextField
• RichTextBuffer
• RichTextCtrl

Requires:

• USE_RICHTEXT

Constant Summary

RICHTEXT_FIELD_STYLE_COMPOSITE =

1

RICHTEXT_FIELD_STYLE_RECTANGLE =

2

RICHTEXT_FIELD_STYLE_NO_BORDER =

4

RICHTEXT_FIELD_STYLE_START_TAG =

8

RICHTEXT_FIELD_STYLE_END_TAG =

16

Instance Method Summary

• #copy(field) ⇒ void

  Copies the object.

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

  Draw the item, within the given range.

• #get_background_colour ⇒ Wx::Colour, ... (also: #background_colour)

  Gets the colour used for drawing the field background.

• #get_bitmap ⇒ Wx::Bitmap (also: #bitmap)

  Gets the bitmap label for fields of this type.

• #get_border_colour ⇒ Wx::Colour, ... (also: #border_colour)

  Gets the colour used for drawing the field border.

• #get_display_style ⇒ Integer (also: #display_style)

  Gets the display style for fields of this type.

• #get_font ⇒ Wx::Font, Wx::FontInfo (also: #font)

  Gets the font used for drawing the text label.

• #get_horizontal_margin ⇒ Integer (also: #horizontal_margin)

  Gets the horizontal margin surrounding the field object.

• #get_horizontal_padding ⇒ Integer (also: #horizontal_padding)

  Sets the horizontal padding (the distance between the border and the text).

• #get_label ⇒ Wx::String (also: #label)

  Returns the text label for fields of this type.

• #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.

• #get_size(obj, dc, context, style) ⇒ Wx::Size (also: #size)

  Get the size of the field, given the label, font size, and so on.

• #get_text_colour ⇒ Wx::Colour, ... (also: #text_colour)

  Gets the colour used for drawing the text label.

• #get_vertical_margin ⇒ Integer (also: #vertical_margin)

  Gets the vertical margin surrounding the field object.

• #get_vertical_padding ⇒ Integer (also: #vertical_padding)

  Gets the vertical padding (the distance between the border and the text).

• #init ⇒ void

  Initialises the object.

• #initialize(*args) ⇒ RichTextFieldTypeStandard constructor

  A new instance of RichTextFieldTypeStandard.

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

  Returns true if the display type is RICHTEXT_FIELD_STYLE_COMPOSITE, false otherwise.

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

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

• #set_background_colour(colour) ⇒ void (also: #background_colour=)

  Sets the colour used for drawing the field background.

• #set_bitmap(bitmap) ⇒ void (also: #bitmap=)

  Sets the bitmap label for fields of this type.

• #set_border_colour(colour) ⇒ void (also: #border_colour=)

  Sets the colour used for drawing the field border.

• #set_display_style(displayStyle) ⇒ void (also: #display_style=)

  Sets the display style for fields of this type.

• #set_font(font) ⇒ void (also: #font=)

  Sets the font used for drawing the text label.

• #set_horizontal_margin(margin) ⇒ void (also: #horizontal_margin=)

  Sets the horizontal margin surrounding the field object.

• #set_horizontal_padding(padding) ⇒ void (also: #horizontal_padding=)

  Sets the horizontal padding (the distance between the border and the text).

• #set_label(label) ⇒ void (also: #label=)

  Sets the text label for fields of this type.

• #set_text_colour(colour) ⇒ void (also: #text_colour=)

  Sets the colour used for drawing the text label.

• #set_vertical_margin(margin) ⇒ void (also: #vertical_margin=)

  Sets the vertical margin surrounding the field object.

• #set_vertical_padding(padding) ⇒ void (also: #vertical_padding=)

  Sets the vertical padding (the distance between the border and the text).

Methods inherited from RichTextFieldType

#can_edit_properties, #edit_properties, #get_name, #get_properties_menu_label, #set_name, #update_field

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(name, label, displayStyle = Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE) ⇒ Wx::RTC::RichTextFieldTypeStandard #initialize(name, bitmap, displayStyle = Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER) ⇒ Wx::RTC::RichTextFieldTypeStandard #initialize ⇒ Wx::RTC::RichTextFieldTypeStandard #initialize(field) ⇒ Wx::RTC::RichTextFieldTypeStandard

Returns a new instance of RichTextFieldTypeStandard.

Overloads:

• #initialize(name, label, displayStyle = Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE) ⇒ Wx::RTC::RichTextFieldTypeStandard

  Constructor, creating a field type definition with a text label.

  Parameters:

  • name (String) —

    The name of the type definition. This must be unique, and is the type name used when adding a field to a control.

  • label (String) —

    The text label to be shown on the field.

  • displayStyle (Integer) (defaults to: Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE) —

    The display style: one of RICHTEXT_FIELD_STYLE_RECTANGLE, RICHTEXT_FIELD_STYLE_NO_BORDER, RICHTEXT_FIELD_STYLE_START_TAG, RICHTEXT_FIELD_STYLE_END_TAG.

• #initialize(name, bitmap, displayStyle = Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER) ⇒ Wx::RTC::RichTextFieldTypeStandard

  Constructor, creating a field type definition with a bitmap label.

  Parameters:

  • name (String) —

    The name of the type definition. This must be unique, and is the type name used when adding a field to a control.

  • bitmap (Wx::Bitmap) —

    The bitmap label to be shown on the field.

  • displayStyle (Integer) (defaults to: Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER) —

    The display style: one of RICHTEXT_FIELD_STYLE_RECTANGLE, RICHTEXT_FIELD_STYLE_NO_BORDER, RICHTEXT_FIELD_STYLE_START_TAG, RICHTEXT_FIELD_STYLE_END_TAG.

• #initialize ⇒ Wx::RTC::RichTextFieldTypeStandard

  The default constructor.
• #initialize(field) ⇒ Wx::RTC::RichTextFieldTypeStandard

  The copy constructor.

  Parameters:

  • field (Wx::RTC::RichTextFieldTypeStandard)

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

def initialize(*args) end

Instance Method Details

#copy(field) ⇒ void

This method returns an undefined value.

Copies the object.

Parameters:

• field (Wx::RTC::RichTextFieldTypeStandard)

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

def copy(field) 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 940

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

#get_background_colour ⇒ Wx::Colour, ... Also known as: background_colour

Gets the colour used for drawing the field background.

Returns:

• (Wx::Colour, String, Symbol)

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

def get_background_colour; end

#get_bitmap ⇒ Wx::Bitmap Also known as: bitmap

Gets the bitmap label for fields of this type.

Returns:

• (Wx::Bitmap)

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

def get_bitmap; end

#get_border_colour ⇒ Wx::Colour, ... Also known as: border_colour

Gets the colour used for drawing the field border.

Returns:

• (Wx::Colour, String, Symbol)

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

def get_border_colour; end

#get_display_style ⇒ Integer Also known as: display_style

Gets the display style for fields of this type.

Returns:

• (Integer)

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

def get_display_style; end

#get_font ⇒ Wx::Font, Wx::FontInfo Also known as: font

Gets the font used for drawing the text label.

Returns:

• (Wx::Font, Wx::FontInfo)

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

def get_font; end

#get_horizontal_margin ⇒ Integer Also known as: horizontal_margin

Gets the horizontal margin surrounding the field object.

Returns:

• (Integer)

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

def get_horizontal_margin; end

#get_horizontal_padding ⇒ Integer Also known as: horizontal_padding

Sets the horizontal padding (the distance between the border and the text).

Returns:

• (Integer)

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

def get_horizontal_padding; end

#get_label ⇒ Wx::String Also known as: label

Returns the text label for fields of this type.

Returns:

• (Wx::String)

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

def get_label; 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 968

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

#get_size(obj, dc, context, style) ⇒ Wx::Size Also known as: size

Get the size of the field, given the label, font size, and so on.

Parameters:

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

Returns:

• (Wx::Size)

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

def get_size(obj, dc, context, style) end

#get_text_colour ⇒ Wx::Colour, ... Also known as: text_colour

Gets the colour used for drawing the text label.

Returns:

• (Wx::Colour, String, Symbol)

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

def get_text_colour; end

#get_vertical_margin ⇒ Integer Also known as: vertical_margin

Gets the vertical margin surrounding the field object.

Returns:

• (Integer)

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

def get_vertical_margin; end

#get_vertical_padding ⇒ Integer Also known as: vertical_padding

Gets the vertical padding (the distance between the border and the text).

Returns:

• (Integer)

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

def get_vertical_padding; end

#init ⇒ void

This method returns an undefined value.

Initialises the object.

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

def init; end

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

Returns true if the display type is RICHTEXT_FIELD_STYLE_COMPOSITE, false otherwise.

Parameters:

• obj (Wx::RTC::RichTextField)

Returns:

• (Boolean)

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

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 952

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

#set_background_colour(colour) ⇒ void Also known as: background_colour=

This method returns an undefined value.

Sets the colour used for drawing the field background.

Parameters:

• colour (Wx::Colour, String, Symbol)

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

def set_background_colour(colour) end

#set_bitmap(bitmap) ⇒ void Also known as: bitmap=

This method returns an undefined value.

Sets the bitmap label for fields of this type.

Parameters:

• bitmap (Wx::Bitmap)

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

def set_bitmap(bitmap) end

#set_border_colour(colour) ⇒ void Also known as: border_colour=

This method returns an undefined value.

Sets the colour used for drawing the field border.

Parameters:

• colour (Wx::Colour, String, Symbol)

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

def set_border_colour(colour) end

#set_display_style(displayStyle) ⇒ void Also known as: display_style=

This method returns an undefined value.

Sets the display style for fields of this type.

Parameters:

• displayStyle (Integer)

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

def set_display_style(displayStyle) end

#set_font(font) ⇒ void Also known as: font=

This method returns an undefined value.

Sets the font used for drawing the text label.

Parameters:

• font (Wx::Font, Wx::FontInfo)

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

def set_font(font) end

#set_horizontal_margin(margin) ⇒ void Also known as: horizontal_margin=

This method returns an undefined value.

Sets the horizontal margin surrounding the field object.

Parameters:

• margin (Integer)

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

def set_horizontal_margin(margin) end

#set_horizontal_padding(padding) ⇒ void Also known as: horizontal_padding=

This method returns an undefined value.

Sets the horizontal padding (the distance between the border and the text).

Parameters:

• padding (Integer)

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

def set_horizontal_padding(padding) end

#set_label(label) ⇒ void Also known as: label=

This method returns an undefined value.

Sets the text label for fields of this type.

Parameters:

• label (String)

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

def set_label(label) end

#set_text_colour(colour) ⇒ void Also known as: text_colour=

This method returns an undefined value.

Sets the colour used for drawing the text label.

Parameters:

• colour (Wx::Colour, String, Symbol)

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

def set_text_colour(colour) end

#set_vertical_margin(margin) ⇒ void Also known as: vertical_margin=

This method returns an undefined value.

Sets the vertical margin surrounding the field object.

Parameters:

• margin (Integer)

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

def set_vertical_margin(margin) end

#set_vertical_padding(padding) ⇒ void Also known as: vertical_padding=

This method returns an undefined value.

Sets the vertical padding (the distance between the border and the text).

Parameters:

• padding (Integer)

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

def set_vertical_padding(padding) end