#include <sprk_publish.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (TextKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (TextKit const &in_kit) const |
TextKit & | operator= (TextKit const &in_kit) |
TextKit & | operator= (TextKit &&in_kit) |
bool | operator== (TextKit const &in_kit) const |
void | Set (TextKit const &in_kit) |
TextKit & | SetColor (RGBColor const &in_color) |
TextKit & | SetFont (Text::Font::Name in_font) |
TextKit & | SetFont (char const *in_font_name, Text::Language in_language, bool in_embed_font) |
TextKit & | SetSize (int in_size) |
TextKit & | SetText (char const *in_text) |
void | Show (TextKit &out_kit) const |
bool | ShowColor (RGBColor &out_color) const |
bool | ShowFont (Text::Font::Type &out_type, Text::Font::Name &out_font, UTF8 &out_font_name, Text::Language &out_language, bool &out_embed_font) const |
bool | ShowSize (int &out_size) const |
bool | ShowText (UTF8 &out_text) const |
TextKit () | |
TextKit (TextKit const &in_kit) | |
TextKit (TextKit &&in_kit) | |
TextKit & | UnsetColor () |
TextKit & | UnsetEverything () |
TextKit & | UnsetFont () |
TextKit & | UnsetSize () |
TextKit & | UnsetText () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Member Functions | |
static TextKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishTextKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
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.
Constructor & Destructor Documentation
HPS::Publish::TextKit::TextKit | ( | ) |
The default constructor creates an empty TextKit object.
HPS::Publish::TextKit::TextKit | ( | TextKit const & | in_kit | ) |
HPS::Publish::TextKit::TextKit | ( | TextKit && | in_kit | ) |
Member Function Documentation
|
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.
bool HPS::Publish::TextKit::Equals | ( | TextKit const & | in_kit | ) | const |
|
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.
|
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.
bool HPS::Publish::TextKit::operator!= | ( | TextKit const & | in_kit | ) | const |
bool HPS::Publish::TextKit::operator== | ( | TextKit const & | in_kit | ) | const |
void HPS::Publish::TextKit::Set | ( | TextKit const & | in_kit | ) |
Sets the color for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_sColor or A3DPDFTextDataEx::m_sColor.
- Parameters
-
in_color Color for the text.
- Returns
- A reference to this TextKit.
TextKit& HPS::Publish::TextKit::SetFont | ( | Text::Font::Name | in_font | ) |
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.
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
-
in_font_name UTF8-encoded font name for the text. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_pcFontName. in_language The language for the font. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_eLanguage. in_embed_font Whether to embed the font in the PDF. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_bEmbedFontInPDF.
- Returns
- A reference to this TextKit.
TextKit& HPS::Publish::TextKit::SetSize | ( | int | in_size | ) |
Sets the size in points for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_iFontSize or A3DPDFTextDataEx::m_iFontSize.
- Parameters
-
in_size The size in points for the text.
- Returns
- A reference to this TextKit.
TextKit& HPS::Publish::TextKit::SetText | ( | char const * | in_text | ) |
Sets the text string for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_pcTextString or A3DPDFTextDataEx::m_pcTextString.
- Parameters
-
in_text UTF8-encoded text string for the text.
- Returns
- A reference to this TextKit.
void HPS::Publish::TextKit::Show | ( | TextKit & | out_kit | ) | const |
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.
bool HPS::Publish::TextKit::ShowFont | ( | Text::Font::Type & | out_type, |
Text::Font::Name & | out_font, | ||
UTF8 & | out_font_name, | ||
Text::Language & | out_language, | ||
bool & | out_embed_font | ||
) | const |
Shows the font setting.
- Parameters
-
out_type The type of font for the text. out_font The built-in font for the text. This is only valid if out_type is Text::Font::Type::BuiltIn. out_font_name The explicit font name for the text. This is only valid if out_type is Text::Font::Type::Explicit. out_language The language for the font. This is only valid if out_type is Text::Font::Type::Explicit. out_embed_font Whether to embed the font in the PDF. This is only valid if out_type is Text::Font::Type::Explicit.
- Returns
- true if a font was specified, false otherwise.
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.
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.
TextKit& HPS::Publish::TextKit::UnsetColor | ( | ) |
Removes the color setting.
- Returns
- A reference to this TextKit.
TextKit& HPS::Publish::TextKit::UnsetEverything | ( | ) |
Removes all data from the text.
- Returns
- A reference to this TextKit.
TextKit& HPS::Publish::TextKit::UnsetFont | ( | ) |
Removes the font setting.
- Returns
- A reference to this TextKit.
TextKit& HPS::Publish::TextKit::UnsetSize | ( | ) |
Removes the size setting.
- Returns
- A reference to this TextKit.
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:
- include/sprk_publish.h