#include <hps.h>
Static Public Attributes | |
| static const HPS::Type | staticType = HPS::Type::TextAttributeControl |
 Static Public Attributes inherited from HPS::Control | |
| static const HPS::Type | staticType = HPS::Type::Control |
| Static Public Attributes inherited from HPS::Object | |
| static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
| Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
| Protected Member Functions inherited from HPS::Control | |
| Control (Control &&in_that) | |
| Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::TextAttributeControl class is a smart pointer that is tied to a database object. This object gives you access to all the attributes associated with text, such as font, size, and rotation. Text characteristics such as bold, italic, and underline are also accessed through the HPS::TextAttributeControl.
Default values for the various fields of HPS::TextAttributeControl can be found here.
Constructor & Destructor Documentation
◆ TextAttributeControl() [1/3]
|
explicit |
Initializes a control tied to the segment in_seg.
◆ TextAttributeControl() [2/3]
| HPS::TextAttributeControl::TextAttributeControl | ( | TextAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
◆ TextAttributeControl() [3/3]
| HPS::TextAttributeControl::TextAttributeControl | ( | TextAttributeControl && | in_that | ) |
The move constructor creates a TextAttributeControl by transferring the underlying impl of the rvalue reference to this TextAttributeControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a TextAttributeControl to take the impl from.
◆ ~TextAttributeControl()
| HPS::TextAttributeControl::~TextAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Control.
◆ operator=() [1/2]
| TextAttributeControl& HPS::TextAttributeControl::operator= | ( | TextAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TextAttributeControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a TextAttributeControl to take the impl from.
- Returns
- A reference to this TextAttributeControl.
◆ operator=() [2/2]
| TextAttributeControl& HPS::TextAttributeControl::operator= | ( | TextAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the TextAttributeControl source.
- Parameters
-
in_that The TextAttributeControl source of the assignment.
- Returns
- A reference to this TextAttributeControl.
◆ SetAlignment()
| TextAttributeControl& HPS::TextAttributeControl::SetAlignment | ( | Text::Alignment | in_align, |
| Text::ReferenceFrame | in_ref = Text::ReferenceFrame::WorldAligned, |
||
| Text::Justification | in_justify = Text::Justification::Left |
||
| ) |
Sets the alignment for text.
- Parameters
-
in_alignment The alignment for text. in_reference_frame The reference frame for text. in_justification The justification for text.
- Returns
- A reference to this object.
◆ SetBackground() [1/3]
| TextAttributeControl& HPS::TextAttributeControl::SetBackground | ( | bool | in_state, |
| char const * | in_name | ||
| ) |
Sets the background to be used with text.
- Parameters
-
in_state Whether a background is drawn for text. in_name The name of a shape definition.
- Returns
- A reference to this object.
◆ SetBackground() [2/3]
| TextAttributeControl& HPS::TextAttributeControl::SetBackground | ( | char const * | in_name | ) |
Sets the background to be used with text. The state is implicitly on.
- Parameters
-
in_name The name of a shape definition.
- Returns
- A reference to this object.
◆ SetBackground() [3/3]
| TextAttributeControl& HPS::TextAttributeControl::SetBackground | ( | bool | in_state | ) |
Sets the background to be used with text.
- Parameters
-
in_state Whether a background is drawn for text.
- Returns
- A reference to this object.
◆ SetBackgroundMargins() [1/3]
| TextAttributeControl& HPS::TextAttributeControl::SetBackgroundMargins | ( | float | in_size, |
| Text::MarginUnits | in_units = Text::MarginUnits::Percent |
||
| ) |
Sets the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
in_size The size of the margins. in_units The units of the size.
- Returns
- A reference to this object.
◆ SetBackgroundMargins() [2/3]
| TextAttributeControl& HPS::TextAttributeControl::SetBackgroundMargins | ( | FloatArray const & | in_size, |
| TextMarginUnitsArray const & | in_units | ||
| ) |
Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines.
- Parameters
-
in_size The size of the margins. in_units The units of the size.
- Returns
- A reference to this object.
◆ SetBackgroundMargins() [3/3]
| TextAttributeControl& HPS::TextAttributeControl::SetBackgroundMargins | ( | size_t | in_count, |
| float const | in_sizes[], | ||
| HPS::Text::MarginUnits const | in_units[] | ||
| ) |
Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines.
- Parameters
-
in_count The number of elements in each array. in_sizes The size of the margins. in_units The units of the size.
- Returns
- A reference to this object.
◆ SetBackgroundStyle()
| TextAttributeControl& HPS::TextAttributeControl::SetBackgroundStyle | ( | char const * | in_name | ) |
Allows specifying a named style to be used in the drawing of text backgrounds. If no style is specified, backgrounds inherit the face and edge attributes from the containing segment.
- Parameters
-
in_name The name of a style, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
◆ SetBold()
| TextAttributeControl& HPS::TextAttributeControl::SetBold | ( | bool | in_state | ) |
Sets whether text should be bold. For fonts which do not have a bold variant, this setting will be ignored.
- Parameters
-
in_state Whether text should be bold.
- Returns
- A reference to this object.
◆ SetExtraSpace() [1/2]
| TextAttributeControl& HPS::TextAttributeControl::SetExtraSpace | ( | bool | in_state, |
| float | in_size = 0.0f, |
||
| Text::SizeUnits | in_units = Text::SizeUnits::ObjectSpace |
||
| ) |
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
in_state Whether to add additional space between characters in a text string. in_size The size of the additional space to add between characters. in_units The units of the size of the additional space to add between characters.
- Returns
- A reference to this object.
◆ SetExtraSpace() [2/2]
| TextAttributeControl& HPS::TextAttributeControl::SetExtraSpace | ( | float | in_size, |
| Text::SizeUnits | in_units | ||
| ) |
Sets the amount of additional space to add between characters in a text string. This function implicitly enables the addition of extra space.
- Parameters
-
in_size The size of the additional space to add between characters. in_units The units of the size of the additional space to add between characters.
- Returns
- A reference to this object.
◆ SetFont()
| TextAttributeControl& HPS::TextAttributeControl::SetFont | ( | char const * | in_name | ) |
Sets the font to use for text. This must either be a builtin font or a font Visualize can locate in the directories specified by World::SetFontDirectories. If the requested font cannot be found, the stroked font will be used.
- Parameters
-
in_name UTF8-encoded font name to use for text.
- Returns
- A reference to this TextKey.
- See also
- World::SetFontDirectories
◆ SetGreeking() [1/2]
| TextAttributeControl& HPS::TextAttributeControl::SetGreeking | ( | bool | in_state, |
| float | in_size = 0.0f, |
||
| Text::GreekingUnits | in_units = Text::GreekingUnits::ObjectSpace, |
||
| Text::GreekingMode | in_mode = Text::GreekingMode::Lines |
||
| ) |
Sets the greeking settings to use for text.
- Parameters
-
in_state Whether greeking is enabled for text. in_size The size below which to draw a simple symbol in place of a character. in_units The units of the size below which to draw a simple glyph in place of a character. in_mode The type of symbol to draw for characters which are smaller than the greeking size.
- Returns
- A reference to this object.
◆ SetGreeking() [2/2]
| TextAttributeControl& HPS::TextAttributeControl::SetGreeking | ( | float | in_size, |
| Text::GreekingUnits | in_units = Text::GreekingUnits::ObjectSpace, |
||
| Text::GreekingMode | in_mode = Text::GreekingMode::Lines |
||
| ) |
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
in_size The size below which to draw a simple symbol in place of a character. in_units The units of the size below which to draw a simple glyph in place of a character. in_mode The type of symbol to draw for characters which are smaller than the greeking size.
- Returns
- A reference to this object.
◆ SetItalic()
| TextAttributeControl& HPS::TextAttributeControl::SetItalic | ( | bool | in_state | ) |
Sets whether text should be italic. For fonts which do not have an italic variant, this setting will be ignored.
- Parameters
-
in_state Whether text should be italic.
- Returns
- A reference to this object.
◆ SetLineSpacing()
| TextAttributeControl& HPS::TextAttributeControl::SetLineSpacing | ( | float | in_multiplier | ) |
Sets the line spacing multiplier for text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string.
- Parameters
-
in_multiplier The line spacing multiplier for text.
- Returns
- A reference to this object.
◆ SetOverline()
| TextAttributeControl& HPS::TextAttributeControl::SetOverline | ( | bool | in_state | ) |
Sets whether an overline should be drawn over text.
- Parameters
-
in_state Whether an overline should be drawn over text.
- Returns
- A reference to this object.
◆ SetPath()
| TextAttributeControl& HPS::TextAttributeControl::SetPath | ( | Vector const & | in_path | ) |
Sets the path for text. This setting controls the vector along which text strings will be displayed.
- Parameters
-
in_path The path for text.
- Returns
- A reference to this object.
◆ SetPreference() [1/2]
| TextAttributeControl& HPS::TextAttributeControl::SetPreference | ( | Text::Preference | in_pref | ) |
Sets the font type preference for text. This function implicitly sets the same font type for all text sizes.
- Parameters
-
in_preference The font type preference for text.
- Returns
- A reference to this object.
◆ SetPreference() [2/2]
| TextAttributeControl& HPS::TextAttributeControl::SetPreference | ( | float | in_cutoff, |
| Text::SizeUnits | in_units, | ||
| Text::Preference | in_smaller, | ||
| Text::Preference | in_larger | ||
| ) |
Sets the preference for text. This setting controls which font type is used for text for "large" and "small" sizes and the cutoff at which this distinction is made.
- Parameters
-
in_cutoff The font size below which the smaller preference is used and above which the larger preference is used. in_units The units for the font size below which the smaller preference is used and above which the larger preference is used. in_smaller The font type preference for strings below the cutoff size. in_larger The font type preference for strings above the cutoff size.
- Returns
- A reference to this object.
◆ SetRenderer()
| TextAttributeControl& HPS::TextAttributeControl::SetRenderer | ( | Text::Renderer | in_rend | ) |
Sets the renderer for text.
- Parameters
-
in_renderer The renderer for text.
- Returns
- A reference to this object.
◆ SetRotation() [1/2]
| TextAttributeControl& HPS::TextAttributeControl::SetRotation | ( | Text::Rotation | in_state, |
| float | in_angle = 0.0f |
||
| ) |
Sets the angle characters should be rotated within text strings.
- Parameters
-
in_state Whether and how to rotate the characters within text string. in_angle The angle in degrees to rotate each character within text strings. This is only relevant if in_state is Text::Rotation::Rotate.
- Returns
- A reference to this object.
◆ SetRotation() [2/2]
| TextAttributeControl& HPS::TextAttributeControl::SetRotation | ( | float | in_angle | ) |
Sets the angle characters should be rotated within text strings. This function implicitly sets a rotation state of Text::Rotation::Rotate.
- Parameters
-
in_angle The angle in degrees to rotate each character within text strings.
- Returns
- A reference to this object.
◆ SetSize()
| TextAttributeControl& HPS::TextAttributeControl::SetSize | ( | float | in_size, |
| Text::SizeUnits | in_units | ||
| ) |
Sets the font size to use for text.
- Parameters
-
in_size The size for text. in_units The units of the size for text.
- Returns
- A reference to this object.
◆ SetSizeTolerance() [1/2]
| TextAttributeControl& HPS::TextAttributeControl::SetSizeTolerance | ( | bool | in_state, |
| float | in_size = 50.0f, |
||
| Text::SizeToleranceUnits | in_units = Text::SizeToleranceUnits::Percent |
||
| ) |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state Whether a size tolerance is enabled for text. in_size The size for the tolerance. in_units The units of the size for the tolerance.
- Returns
- A reference to this object.
◆ SetSizeTolerance() [2/2]
| TextAttributeControl& HPS::TextAttributeControl::SetSizeTolerance | ( | float | in_size, |
| Text::SizeToleranceUnits | in_units | ||
| ) |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. This function implicitly enables a size tolerance.
- Parameters
-
in_size The size for the tolerance. in_units The units of the size for the tolerance.
- Returns
- A reference to this object.
◆ SetSlant()
| TextAttributeControl& HPS::TextAttributeControl::SetSlant | ( | float | in_angle | ) |
Sets the slant angle for text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular.
- Parameters
-
in_angle The angle in degrees to slant text. This value must be in the range [-75.0f,+75.0f].
- Returns
- A reference to this object.
◆ SetSpacing()
| TextAttributeControl& HPS::TextAttributeControl::SetSpacing | ( | float | in_multiplier | ) |
Sets the spacing multiplier for text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on.
- Parameters
-
in_multiplier The spacing multiplier for text.
- Returns
- A reference to this object.
◆ SetStrikethrough()
| TextAttributeControl& HPS::TextAttributeControl::SetStrikethrough | ( | bool | in_state | ) |
Sets whether a strikethrough should be drawn through text.
- Parameters
-
in_state Whether a strikethrough should be drawn through text.
- Returns
- A reference to this object.
◆ SetTransform()
| TextAttributeControl& HPS::TextAttributeControl::SetTransform | ( | Text::Transform | in_trans | ) |
Sets the transform behavior for text.
- Parameters
-
in_transform The transform behavior for text.
- Returns
- A reference to this object.
◆ SetUnderline()
| TextAttributeControl& HPS::TextAttributeControl::SetUnderline | ( | bool | in_state | ) |
Sets whether an underline should be drawn under text.
- Parameters
-
in_state Whether an underline should be drawn under text.
- Returns
- A reference to this object.
◆ ShowAlignment()
| bool HPS::TextAttributeControl::ShowAlignment | ( | Text::Alignment & | out_align, |
| Text::ReferenceFrame & | out_ref, | ||
| Text::Justification & | out_justify | ||
| ) | const |
Shows the alignment for text.
- Parameters
-
out_alignment The alignment for text. out_reference_frame The reference frame for text. out_justification The justification for text.
- Returns
- true if an alignment was set, false otherwise.
◆ ShowBackground()
| bool HPS::TextAttributeControl::ShowBackground | ( | bool & | out_state, |
| UTF8 & | out_name | ||
| ) | const |
Shows the background to be used with text.
- Parameters
-
out_state Whether a background is drawn for text. out_name The name of a shape definition.
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowBackgroundMargins()
| bool HPS::TextAttributeControl::ShowBackgroundMargins | ( | FloatArray & | out_size, |
| TextMarginUnitsArray & | out_units | ||
| ) | const |
Shows the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
out_size The size of the margins. out_units The units of the sizes.
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowBackgroundStyle()
| bool HPS::TextAttributeControl::ShowBackgroundStyle | ( | UTF8 & | out_name | ) | const |
Shows the named style to be used in the drawing of text backgrounds.
- Parameters
-
out_name The name of a style, defined in a portfolio that is accessible.
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowBold()
| bool HPS::TextAttributeControl::ShowBold | ( | bool & | out_state | ) | const |
Shows whether text should be bold.
- Parameters
-
out_state Whether text should be bold.
- Returns
- true if a bold setting was set, false otherwise.
◆ ShowExtraSpace()
| bool HPS::TextAttributeControl::ShowExtraSpace | ( | bool & | out_state, |
| float & | out_size, | ||
| Text::SizeUnits & | out_units | ||
| ) | const |
Shows the amount of additional space to add between characters in a text string.
- Parameters
-
out_state Whether to add additional space between characters in a text string. out_size The size of the additional space to add between characters. out_units The units of the size of the additional space to add between characters.
- Returns
- true if an extra space setting was set, false otherwise.
◆ ShowFont()
| bool HPS::TextAttributeControl::ShowFont | ( | UTF8 & | out_name | ) | const |
Shows the font to use for text.
- Parameters
-
out_name UTF8-encoded font name to use for text.
- Returns
- true if a font was set, false otherwise.
◆ ShowGreeking()
| bool HPS::TextAttributeControl::ShowGreeking | ( | bool & | out_state, |
| float & | out_size, | ||
| Text::GreekingUnits & | out_units, | ||
| Text::GreekingMode & | out_mode | ||
| ) | const |
Shows the greeking settings to use for text.
- Parameters
-
out_state Whether greeking is enabled for text. out_size The size below which to draw a simple symbol in place of a character. out_units The units of the size below which to draw a simple glyph in place of a character. out_mode The type of symbol to draw for characters which are smaller than the greeking size.
- Returns
- true if greeking settings were set, false otherwise.
◆ ShowItalic()
| bool HPS::TextAttributeControl::ShowItalic | ( | bool & | out_state | ) | const |
Shows whether text should be italic.
- Parameters
-
out_state Whether text should be italic.
- Returns
- true if an italic setting was set, false otherwise.
◆ ShowLineSpacing()
| bool HPS::TextAttributeControl::ShowLineSpacing | ( | float & | out_multiplier | ) | const |
Shows the line spacing multiplier for text.
- Parameters
-
out_multiplier The line spacing multiplier for text.
- Returns
- true if a line space multiplier was set, false otherwise.
◆ ShowOverline()
| bool HPS::TextAttributeControl::ShowOverline | ( | bool & | out_state | ) | const |
Shows whether an overline should be drawn over text.
- Parameters
-
out_state Whether an overline should be drawn over text.
- Returns
- true if an overline setting was set, false otherwise.
◆ ShowPath()
| bool HPS::TextAttributeControl::ShowPath | ( | Vector & | out_path | ) | const |
Shows the path for text.
- Parameters
-
out_path The path for text.
- Returns
- true if a path was set, false otherwise.
◆ ShowPreference()
| bool HPS::TextAttributeControl::ShowPreference | ( | float & | out_cutoff, |
| Text::SizeUnits & | out_units, | ||
| Text::Preference & | out_smaller, | ||
| Text::Preference & | out_larger | ||
| ) | const |
Shows the preference for text.
- Parameters
-
out_cutoff The font size below which the smaller preference is used and above which the larger preference is used. out_units The units for the font size below which the smaller preference is used and above which the larger preference is used. out_smaller The font type preference for strings below the cutoff size. out_larger The font type preference for strings above the cutoff size.
- Returns
- true if a preference was set, false otherwise.
◆ ShowRenderer()
| bool HPS::TextAttributeControl::ShowRenderer | ( | Text::Renderer & | out_rend | ) | const |
Shows the renderer for text.
- Parameters
-
in_renderer The renderer for text.
- Returns
- true if a renderer was set, false otherwise.
◆ ShowRotation()
| bool HPS::TextAttributeControl::ShowRotation | ( | Text::Rotation & | out_rot, |
| float & | out_angle | ||
| ) | const |
Shows the angle characters should be rotated within text strings.
- Parameters
-
out_rot Whether to rotate the characters within text strings, and if so, what the angle should be measured with repect to. out_angle The angle in degrees to rotate each character within text strings.
- Returns
- true if a rotation setting was set, false otherwise.
◆ ShowSize()
| bool HPS::TextAttributeControl::ShowSize | ( | float & | out_size, |
| Text::SizeUnits & | out_units | ||
| ) | const |
Shows the font size to use for text.
- Parameters
-
out_size The size for text. out_units The units of the size for text.
- Returns
- true if a size was set, false otherwise.
◆ ShowSizeTolerance()
| bool HPS::TextAttributeControl::ShowSizeTolerance | ( | bool & | out_state, |
| float & | out_size, | ||
| Text::SizeToleranceUnits & | out_units | ||
| ) | const |
Shows the size tolerance settings to use for text.
- Parameters
-
out_state Whether a size tolerance is enabled for text. out_size The size for the tolerance. out_units The units of the size for the tolerance.
- Returns
- true if a size tolerance was set, false otherwise.
◆ ShowSlant()
| bool HPS::TextAttributeControl::ShowSlant | ( | float & | out_angle | ) | const |
Shows the slant angle for text.
- Parameters
-
out_angle The angle in degrees to slant text.
- Returns
- true if a slang angle was set, false otherwise.
◆ ShowSpacing()
| bool HPS::TextAttributeControl::ShowSpacing | ( | float & | out_multiplier | ) | const |
Shows the spacing multiplier for text.
- Parameters
-
out_multiplier The spacing multiplier for text.
- Returns
- true if a spacing multiplier was set, false otherwise.
◆ ShowStrikethrough()
| bool HPS::TextAttributeControl::ShowStrikethrough | ( | bool & | out_state | ) | const |
Shows whether a strikethrough should be drawn through text.
- Parameters
-
out_state Whether a strikethrough should be drawn through text.
- Returns
- true if a strikethrough setting was set, false otherwise.
◆ ShowTransform()
| bool HPS::TextAttributeControl::ShowTransform | ( | Text::Transform & | out_trans | ) | const |
Shows the transform state for text.
- Parameters
-
out_transform The transform state for text.
- Returns
- true if a transform state was set, false otherwise.
◆ ShowUnderline()
| bool HPS::TextAttributeControl::ShowUnderline | ( | bool & | out_state | ) | const |
Shows whether an underline should be drawn under text.
- Parameters
-
out_state Whether an underline should be drawn under text.
- Returns
- true if an underline setting was set, false otherwise.
◆ Type()
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
◆ UnsetAlignment()
| TextAttributeControl& HPS::TextAttributeControl::UnsetAlignment | ( | ) |
Removes the alignment setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetBackground()
| TextAttributeControl& HPS::TextAttributeControl::UnsetBackground | ( | ) |
Removes the background setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetBackgroundMargins()
| TextAttributeControl& HPS::TextAttributeControl::UnsetBackgroundMargins | ( | ) |
Removes the background margin setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetBackgroundStyle()
| TextAttributeControl& HPS::TextAttributeControl::UnsetBackgroundStyle | ( | ) |
Removes the background style setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetBold()
| TextAttributeControl& HPS::TextAttributeControl::UnsetBold | ( | ) |
Removes the bold setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetEverything()
| TextAttributeControl& HPS::TextAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetExtraSpace()
| TextAttributeControl& HPS::TextAttributeControl::UnsetExtraSpace | ( | ) |
Removes the extra space setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetFont()
| TextAttributeControl& HPS::TextAttributeControl::UnsetFont | ( | ) |
Removes the font setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetGreeking()
| TextAttributeControl& HPS::TextAttributeControl::UnsetGreeking | ( | ) |
Removes the greeking setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetItalic()
| TextAttributeControl& HPS::TextAttributeControl::UnsetItalic | ( | ) |
Removes the italic setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetLineSpacing()
| TextAttributeControl& HPS::TextAttributeControl::UnsetLineSpacing | ( | ) |
Removes the line spacing setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetOverline()
| TextAttributeControl& HPS::TextAttributeControl::UnsetOverline | ( | ) |
Removes the overline setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetPath()
| TextAttributeControl& HPS::TextAttributeControl::UnsetPath | ( | ) |
Removes the path setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetPreference()
| TextAttributeControl& HPS::TextAttributeControl::UnsetPreference | ( | ) |
Removes the preference setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetRenderer()
| TextAttributeControl& HPS::TextAttributeControl::UnsetRenderer | ( | ) |
Removes the renderer setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetRotation()
| TextAttributeControl& HPS::TextAttributeControl::UnsetRotation | ( | ) |
Removes the rotation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetSize()
| TextAttributeControl& HPS::TextAttributeControl::UnsetSize | ( | ) |
Removes the size setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetSizeTolerance()
| TextAttributeControl& HPS::TextAttributeControl::UnsetSizeTolerance | ( | ) |
Removes the size tolerance setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetSlant()
| TextAttributeControl& HPS::TextAttributeControl::UnsetSlant | ( | ) |
Removes the slant setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetSpacing()
| TextAttributeControl& HPS::TextAttributeControl::UnsetSpacing | ( | ) |
Removes the spacing setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetStrikethrough()
| TextAttributeControl& HPS::TextAttributeControl::UnsetStrikethrough | ( | ) |
Removes the strikethrough setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetTransform()
| TextAttributeControl& HPS::TextAttributeControl::UnsetTransform | ( | ) |
Removes the transform setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetUnderline()
| TextAttributeControl& HPS::TextAttributeControl::UnsetUnderline | ( | ) |
Removes the underline setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TextAttributeKit::GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h