Class: Wx::RTC::RichTextContextMenuPropertiesInfo

Inherits:

Object

• Object
• Wx::RTC::RichTextContextMenuPropertiesInfo

Defined in:

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

Overview

Note:

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

RichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu, whose properties are available to be edited.

Requires:

• USE_RICHTEXT

Instance Method Summary

• #add_item(label, obj) ⇒ Boolean

  Adds an item.

• #add_items(ctrl, container, obj) ⇒ Integer

  Adds appropriate menu items for the current container and clicked on object (and container's parent, if appropriate).

• #add_menu_items(menu, startCmd = wxID_RICHTEXT_PROPERTIES1) ⇒ Integer

  Returns the number of menu items that were added.

• #clear ⇒ void

  Clears the items.

• #get_count ⇒ Integer (also: #count)

  Returns the number of items.

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

  Returns the nth label.

• #get_labels ⇒ Wx::ArrayString (also: #labels)

  Returns the array of labels.

• #get_object(n) ⇒ Wx::RTC::RichTextObject (also: #object)

  Returns the nth object.

• #get_objects ⇒ Array<Wx::RTC::RichTextObject> (also: #objects)

  Returns the array of objects.

• #init ⇒ void

  Initialisation.

• #initialize ⇒ Wx::RTC::RichTextContextMenuPropertiesInfo constructor

  Constructor.

Constructor Details

#initialize ⇒ Wx::RTC::RichTextContextMenuPropertiesInfo

Constructor.

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1932

def initialize; end

Instance Method Details

#add_item(label, obj) ⇒ Boolean

Adds an item.

Parameters:

• label (String)
• obj (Wx::RTC::RichTextObject)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1942

def add_item(label, obj) end

#add_items(ctrl, container, obj) ⇒ Integer

Adds appropriate menu items for the current container and clicked on object (and container's parent, if appropriate).

Parameters:

• ctrl (Wx::RTC::RichTextCtrl)
• container (Wx::RTC::RichTextObject)
• obj (Wx::RTC::RichTextObject)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1955

def add_items(ctrl, container, obj) end

#add_menu_items(menu, startCmd = wxID_RICHTEXT_PROPERTIES1) ⇒ Integer

Returns the number of menu items that were added.

Parameters:

• menu (Wx::Menu)
• startCmd (Integer) (defaults to: wxID_RICHTEXT_PROPERTIES1)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1948

def add_menu_items(menu, startCmd=wxID_RICHTEXT_PROPERTIES1) end

#clear ⇒ void

This method returns an undefined value.

Clears the items.

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1959

def clear; end

#get_count ⇒ Integer Also known as: count

Returns the number of items.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1985

def get_count; end

#get_label(n) ⇒ String Also known as: label

Returns the nth label.

Parameters:

• n (Integer)

Returns:

• (String)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1964

def get_label(n) end

#get_labels ⇒ Wx::ArrayString Also known as: labels

Returns the array of labels.

Returns:

• (Wx::ArrayString)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1980

def get_labels; end

#get_object(n) ⇒ Wx::RTC::RichTextObject Also known as: object

Returns the nth object.

Parameters:

• n (Integer)

Returns:

• (Wx::RTC::RichTextObject)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1970

def get_object(n) end

#get_objects ⇒ Array<Wx::RTC::RichTextObject> Also known as: objects

Returns the array of objects.

Returns:

• (Array<Wx::RTC::RichTextObject>)

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1975

def get_objects; end

#init ⇒ void

This method returns an undefined value.

Initialisation.

# File 'lib/wx/doc/gen/rtc/rich_text_ctrl.rb', line 1936

def init; end