#include <sprk_publish.h>
|
static const HPS::Type | staticType = HPS::Type::PublishTextKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The TextKit class is a user space object. It acts as the container for all data that can be used to specify a text string for a Publish PDF.
◆ TextKit() [1/3]
HPS::Publish::TextKit::TextKit |
( |
| ) |
|
The default constructor creates an empty TextKit object.
◆ TextKit() [2/3]
HPS::Publish::TextKit::TextKit |
( |
TextKit const & |
in_kit | ) |
|
The copy constructor creates a new TextKit object that contains the same settings as the source TextKit.
- Parameters
-
◆ TextKit() [3/3]
HPS::Publish::TextKit::TextKit |
( |
TextKit && |
in_kit | ) |
|
The move constructor creates a TextKit by transferring the underlying object of the rvalue reference to this TextKit.
- Parameters
-
in_kit | An rvalue reference to a TextKit to take the underlying object from. |
◆ Empty()
bool HPS::Publish::TextKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this TextKit has any values set on it.
- Returns
- true if no values are set on this TextKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::Publish::TextKit::Equals |
( |
TextKit const & |
in_kit | ) |
const |
Check if the source TextKit is equivalent to this TextKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
static TextKit HPS::Publish::TextKit::GetDefault |
( |
| ) |
|
|
static |
Creates a TextKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the TextKit passed to File::Export.
- Returns
- A TextKit with the default settings.
◆ ObjectType()
HPS::Type HPS::Publish::TextKit::ObjectType |
( |
| ) |
const |
|
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::SprocketKit.
◆ operator!=()
bool HPS::Publish::TextKit::operator!= |
( |
TextKit const & |
in_kit | ) |
const |
Check if the source TextKit is not equivalent to this TextKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying object of the rvalue reference to this TextKit.
- Parameters
-
in_kit | An rvalue reference to a TextKit to take the underlying object from. |
- Returns
- A reference to this TextKit.
◆ operator==()
bool HPS::Publish::TextKit::operator== |
( |
TextKit const & |
in_kit | ) |
const |
Check if the source TextKit is equivalent to this TextKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Publish::TextKit::Set |
( |
TextKit const & |
in_kit | ) |
|
◆ SetColor()
◆ SetFont() [1/2]
Sets a built-in font for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_eFontName.
- Parameters
-
in_font | The built-in font for the text. |
- Returns
- A reference to this TextKit.
◆ SetFont() [2/2]
TextKit& HPS::Publish::TextKit::SetFont |
( |
char const * |
in_font_name, |
|
|
Text::Language |
in_language, |
|
|
bool |
in_embed_font |
|
) |
| |
Sets an explicit font for the text. As of Publish 5.11, this is only known to create a valid text string in the PDF if the font name is "MS Gothic" and the language is Japanese, otherwise the creation will fail.
- Parameters
-
- Returns
- A reference to this TextKit.
◆ SetSize()
TextKit& HPS::Publish::TextKit::SetSize |
( |
int |
in_size | ) |
|
◆ SetText()
TextKit& HPS::Publish::TextKit::SetText |
( |
char const * |
in_text | ) |
|
◆ Show()
void HPS::Publish::TextKit::Show |
( |
TextKit & |
out_kit | ) |
const |
◆ ShowColor()
bool HPS::Publish::TextKit::ShowColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the color setting
- Parameters
-
out_color | The color for the text. |
- Returns
- true if a color was specified, false otherwise.
◆ ShowFont()
Shows the font setting.
- Parameters
-
- Returns
- true if a font was specified, false otherwise.
◆ ShowSize()
bool HPS::Publish::TextKit::ShowSize |
( |
int & |
out_size | ) |
const |
Shows the size setting.
- Parameters
-
out_size | The size for the text. |
- Returns
- true if a size was specified, false otherwise.
◆ ShowText()
bool HPS::Publish::TextKit::ShowText |
( |
UTF8 & |
out_text | ) |
const |
Shows the text string setting.
- Parameters
-
out_text | The text string for the text. |
- Returns
- true if a text string was specified, false otherwise.
◆ UnsetColor()
TextKit& HPS::Publish::TextKit::UnsetColor |
( |
| ) |
|
Removes the color setting.
- Returns
- A reference to this TextKit.
◆ UnsetEverything()
TextKit& HPS::Publish::TextKit::UnsetEverything |
( |
| ) |
|
Removes all data from the text.
- Returns
- A reference to this TextKit.
◆ UnsetFont()
TextKit& HPS::Publish::TextKit::UnsetFont |
( |
| ) |
|
Removes the font setting.
- Returns
- A reference to this TextKit.
◆ UnsetSize()
TextKit& HPS::Publish::TextKit::UnsetSize |
( |
| ) |
|
Removes the size setting.
- Returns
- A reference to this TextKit.
◆ UnsetText()
TextKit& HPS::Publish::TextKit::UnsetText |
( |
| ) |
|
Removes the text string setting.
- Returns
- A reference to this TextKit.
The documentation for this class was generated from the following file: