Class: Wx::RTC::RichTextProperties

Inherits:

Object

Object
Object
Wx::RTC::RichTextProperties

show all

Defined in:: lib/wx/doc/gen/rtc/rich_text_object.rb

Overview

Note:

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

A simple property class using Variants.

This is used to give each rich text object the ability to store custom properties that can be used by the application.

Category: Rich Text

Instance Method Summary collapse

#==(props) ⇒ Boolean
Equality operator.
#clear ⇒ void
Clears the properties.
#copy(props) ⇒ void
Copies from props.
#find(name) ⇒ Integer
Finds the given property.
#find_or_create_property(name) ⇒ Wx::Variant
Finds or creates a property with the given name, returning a pointer to the variant.
#get_count ⇒ Integer (also: #count)
Returns a count of the properties.
#get_properties ⇒ Array<Wx::Variant> (also: #properties)
Returns the array of variants implementing the properties.
#get_property(name) ⇒ Wx::Variant (also: #property)
Gets the property variant by name.
#get_property_bool(name) ⇒ Boolean (also: #property_bool)
Gets the value of the named property as a boolean.
#get_property_double(name) ⇒ Float (also: #property_double)
Gets the value of the named property as a double.
#get_property_long(name) ⇒ Integer (also: #property_long)
Gets the value of the named property as a long integer.
#get_property_names ⇒ Array<String> (also: #property_names)
Returns all the property names.
#get_property_string(name) ⇒ String (also: #property_string)
Gets the value of the named property as a string.
#has_property(name) ⇒ Boolean (also: #has_property?)
Returns true if the given property is found.
#initialize(*args) ⇒ RichTextProperties constructor
A new instance of RichTextProperties.
#merge_properties(properties) ⇒ void
Merges the given properties with these properties.
#remove(name) ⇒ Boolean
Removes the given property.
#remove_properties(properties) ⇒ void
Removes the given properties from these properties.
#set_properties(props) ⇒ void (also: #properties=)
Sets the array of variants.
#set_property(*args) ⇒ Object (also: #property=)

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ `Wx::RTC::RichTextProperties` #initialize(props) ⇒ `Wx::RTC::RichTextProperties`

Returns a new instance of RichTextProperties.

Overloads:

#initialize ⇒ Wx::RTC::RichTextProperties

Default constructor.
#initialize(props) ⇒ Wx::RTC::RichTextProperties

Copy constructor.
Parameters:
- props (Wx::RTC::RichTextProperties)

2787	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2787 def initialize(*args) end

Instance Method Details

#==(props) ⇒ `Boolean`

Equality operator.

Parameters:

props (Wx::RTC::RichTextProperties)

Returns:

(Boolean)

2792	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2792 def ==(props) end

#clear ⇒ `void`

This method returns an undefined value.

Clears the properties.

2801	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2801 def clear; end

#copy(props) ⇒ `void`

This method returns an undefined value.

Copies from props.

Parameters:

props (Wx::RTC::RichTextProperties)

2797	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2797 def copy(props) end

#find(name) ⇒ `Integer`

Finds the given property.

Parameters:

name (String)

Returns:

(Integer)

2833	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2833 def find(name) end

#find_or_create_property(name) ⇒ `Wx::Variant`

Finds or creates a property with the given name, returning a pointer to the variant.

Parameters:

name (String)

Returns:

(Wx::Variant)

2849	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2849 def find_or_create_property(name) end

#get_count ⇒ `Integer` Also known as: count

Returns a count of the properties.

Returns:

(Integer)

2821	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2821 def get_count; end

#get_properties ⇒ `Array<Wx::Variant>` Also known as: properties

Returns the array of variants implementing the properties.

Returns:

(Array<Wx::Variant>)

2805	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2805 def get_properties; end

#get_property(name) ⇒ `Wx::Variant` Also known as: property

Gets the property variant by name.

Parameters:

name (String)

Returns:

(Wx::Variant)

2843	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2843 def get_property(name) end

#get_property_bool(name) ⇒ `Boolean` Also known as: property_bool

Gets the value of the named property as a boolean.

Parameters:

name (String)

Returns:

(Boolean)

2866	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2866 def get_property_bool(name) end

#get_property_double(name) ⇒ `Float` Also known as: property_double

Gets the value of the named property as a double.

Parameters:

name (String)

Returns:

(Float)

2872	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2872 def get_property_double(name) end

#get_property_long(name) ⇒ `Integer` Also known as: property_long

Gets the value of the named property as a long integer.

Parameters:

name (String)

Returns:

(Integer)

2860	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2860 def get_property_long(name) end

#get_property_names ⇒ `Array<String>` Also known as: property_names

Returns all the property names.

Returns:

(Array<String>)

2816	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2816 def get_property_names; end

#get_property_string(name) ⇒ `String` Also known as: property_string

Gets the value of the named property as a string.

Parameters:

name (String)

Returns:

(String)

2854	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2854 def get_property_string(name) end

#has_property(name) ⇒ `Boolean` Also known as: has_property?

Returns true if the given property is found.

Parameters:

name (String)

Returns:

(Boolean)

2827	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2827 def has_property(name) end

#merge_properties(properties) ⇒ `void`

This method returns an undefined value.

Merges the given properties with these properties.

Parameters:

properties (Wx::RTC::RichTextProperties)

2915	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2915 def merge_properties(properties) end

#remove(name) ⇒ `Boolean`

Removes the given property.

Parameters:

name (String)

Returns:

(Boolean)

2838	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2838 def remove(name) end

#remove_properties(properties) ⇒ `void`

This method returns an undefined value.

Removes the given properties from these properties.

Parameters:

properties (Wx::RTC::RichTextProperties)

2910	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2910 def remove_properties(properties) end

#set_properties(props) ⇒ `void` Also known as: properties=

This method returns an undefined value.

Sets the array of variants.

Parameters:

props (Array<Wx::Variant>)

2811	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2811 def set_properties(props) end

#set_property(variant) ⇒ `void` #set_property(name, variant) ⇒ `void` #set_property(name, value) ⇒ `void` #set_property(name, value) ⇒ `void` #set_property(name, value) ⇒ `void` #set_property(name, value) ⇒ `void` Also known as: property=

Overloads:

#set_property(variant) ⇒ void

This method returns an undefined value.
Sets the property by passing a variant which contains a name and value.
Parameters:
- variant (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue)
#set_property(name, variant) ⇒ void

This method returns an undefined value.
Sets a property by name and variant.
Parameters:
- name (String)
- variant (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue)
#set_property(name, value) ⇒ void

This method returns an undefined value.
Sets a property by name and string value.
Parameters:
- name (String)
- value (String)
#set_property(name, value) ⇒ void

This method returns an undefined value.
Sets property by name and long integer value.
Parameters:
- name (String)
- value (Integer)
#set_property(name, value) ⇒ void

This method returns an undefined value.
Sets property by name and double value.
Parameters:
- name (String)
- value (Float)
#set_property(name, value) ⇒ void

This method returns an undefined value.
Sets property by name and boolean value.
Parameters:
- name (String)
- value (Boolean)

2904	# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2904 def set_property(*args) end

Class: Wx::RTC::RichTextProperties

Overview

Instance Method Summary collapse

Methods inherited from Object

Constructor Details

#initialize ⇒ Wx::RTC::RichTextProperties #initialize(props) ⇒ Wx::RTC::RichTextProperties

Instance Method Details

#==(props) ⇒ Boolean

#clear ⇒ void

#copy(props) ⇒ void

#find(name) ⇒ Integer

#find_or_create_property(name) ⇒ Wx::Variant

#get_count ⇒ Integer Also known as: count

#get_properties ⇒ Array<Wx::Variant> Also known as: properties

#get_property(name) ⇒ Wx::Variant Also known as: property

#get_property_bool(name) ⇒ Boolean Also known as: property_bool

#get_property_double(name) ⇒ Float Also known as: property_double

#get_property_long(name) ⇒ Integer Also known as: property_long

#get_property_names ⇒ Array<String> Also known as: property_names

#get_property_string(name) ⇒ String Also known as: property_string

#has_property(name) ⇒ Boolean Also known as: has_property?

#merge_properties(properties) ⇒ void

#remove(name) ⇒ Boolean

#remove_properties(properties) ⇒ void

#set_properties(props) ⇒ void Also known as: properties=

#set_property(variant) ⇒ void #set_property(name, variant) ⇒ void #set_property(name, value) ⇒ void #set_property(name, value) ⇒ void #set_property(name, value) ⇒ void #set_property(name, value) ⇒ void Also known as: property=

#initialize ⇒ `Wx::RTC::RichTextProperties` #initialize(props) ⇒ `Wx::RTC::RichTextProperties`

#==(props) ⇒ `Boolean`

#clear ⇒ `void`

#copy(props) ⇒ `void`

#find(name) ⇒ `Integer`

#find_or_create_property(name) ⇒ `Wx::Variant`

#get_count ⇒ `Integer` Also known as: count

#get_properties ⇒ `Array<Wx::Variant>` Also known as: properties

#get_property(name) ⇒ `Wx::Variant` Also known as: property

#get_property_bool(name) ⇒ `Boolean` Also known as: property_bool

#get_property_double(name) ⇒ `Float` Also known as: property_double

#get_property_long(name) ⇒ `Integer` Also known as: property_long

#get_property_names ⇒ `Array<String>` Also known as: property_names

#get_property_string(name) ⇒ `String` Also known as: property_string

#has_property(name) ⇒ `Boolean` Also known as: has_property?

#merge_properties(properties) ⇒ `void`

#remove(name) ⇒ `Boolean`

#remove_properties(properties) ⇒ `void`

#set_properties(props) ⇒ `void` Also known as: properties=

#set_property(variant) ⇒ `void` #set_property(name, variant) ⇒ `void` #set_property(name, value) ⇒ `void` #set_property(name, value) ⇒ `void` #set_property(name, value) ⇒ `void` #set_property(name, value) ⇒ `void` Also known as: property=