Class: Wx::RTC::RichTextProperties
- Defined in:
- lib/wx/doc/gen/rtc/rich_text_object.rb
Overview
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.
2783 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2783 def initialize(*args) end |
Instance Method Details
#==(props) ⇒ Boolean
Equality operator.
2788 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2788 def ==(props) end |
#clear ⇒ void
This method returns an undefined value.
Clears the properties.
2797 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2797 def clear; end |
#copy(props) ⇒ void
This method returns an undefined value.
Copies from props.
2793 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2793 def copy(props) end |
#find(name) ⇒ Integer
Finds the given property.
2829 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2829 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.
2845 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2845 def find_or_create_property(name) end |
#get_count ⇒ Integer Also known as: count
Returns a count of the properties.
2817 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2817 def get_count; end |
#get_properties ⇒ Array<Wx::Variant> Also known as: properties
Returns the array of variants implementing the properties.
2801 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2801 def get_properties; end |
#get_property(name) ⇒ Wx::Variant Also known as: property
Gets the property variant by name.
2839 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2839 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.
2862 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2862 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.
2868 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2868 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.
2856 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2856 def get_property_long(name) end |
#get_property_names ⇒ Array<String> Also known as: property_names
Returns all the property names.
2812 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2812 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.
2850 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2850 def get_property_string(name) end |
#has_property(name) ⇒ Boolean Also known as: has_property?
Returns true if the given property is found.
2823 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2823 def has_property(name) end |
#merge_properties(properties) ⇒ void
This method returns an undefined value.
Merges the given properties with these properties.
2911 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2911 def merge_properties(properties) end |
#remove(name) ⇒ Boolean
Removes the given property.
2834 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2834 def remove(name) end |
#remove_properties(properties) ⇒ void
This method returns an undefined value.
Removes the given properties from these properties.
2906 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2906 def remove_properties(properties) end |
#set_properties(props) ⇒ void Also known as: properties=
This method returns an undefined value.
Sets the array of variants.
2807 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2807 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=
2900 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2900 def set_property(*args) end |