HPS::Publish::TextKit

class HPS::Publish::TextKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this TextKit has any values set on it.

Returns: true if no values are set on this TextKit, false otherwise.

bool Equals(TextKit const &in_kit) const

Check if the source TextKit is equivalent to this TextKit.

Parameters: in_kit – The source TextKit to compare to this TextKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(TextKit const &in_kit) const

Check if the source TextKit is not equivalent to this TextKit.

Parameters: in_kit – The source TextKit to compare to this TextKit.
Returns: true if the objects are not equivalent, false otherwise.

TextKit &operator=(TextKit &&in_kit)

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.

TextKit &operator=(TextKit const &in_kit)

Copies the source TextKit into this TextKit.

Parameters: in_kit – The source TextKit to copy.
Returns: A reference to this TextKit.

bool operator==(TextKit const &in_kit) const

Check if the source TextKit is equivalent to this TextKit.

Parameters: in_kit – The source TextKit to compare to this TextKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(TextKit const &in_kit)

Copies the source TextKit into this TextKit.

Parameters: in_kit – The source TextKit to copy.

TextKit &SetColor(RGBColor const &in_color)

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 &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 &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 &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 &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 Show(TextKit &out_kit) const

Copies this TextKit into the given TextKit.

Parameters: out_kit – The TextKit to populate with the contents of this TextKit.

bool 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 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 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 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(): The default constructor creates an empty TextKit object.

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.

TextKit(TextKit const &in_kit)

The copy constructor creates a new TextKit object that contains the same settings as the source TextKit.

Parameters: in_kit – The source TextKit to copy.

TextKit &UnsetColor()

Removes the color setting.

Returns: A reference to this TextKit.

TextKit &UnsetEverything()

Removes all data from the text.

Returns: A reference to this TextKit.

TextKit &UnsetFont()

Removes the font setting.

Returns: A reference to this TextKit.

TextKit &UnsetSize()

Removes the size setting.

Returns: A reference to this TextKit.

TextKit &UnsetText()

Removes the text string setting.

Returns: A reference to this TextKit.

Public Static Functions

static TextKit GetDefault()

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.