HPS::Publish::ExportOptionsKit

class HPS::Publish::ExportOptionsKit : public HPS::SprocketKit

The ExportOptionsKit class is a user space object. It contains settings controlling how 3D PDF data is exported via Publish.

Public Functions

virtual bool Empty() const

Indicates whether this ExportOptionsKit has any values set on it.

Returns

true if no values are set on this ExportOptionsKit, false otherwise.

bool Equals(ExportOptionsKit const &in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters

in_kit – The source ExportOptionsKit to compare to this ExportOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

ExportOptionsKit()

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit(ExportOptionsKit &&in_kit)

The move constructor creates an ExportOptionsKit by transferring the underlying object of the rvalue reference to this ExportOptionsKit.

Parameters

in_kit – An rvalue reference to an ExportOptionsKit to take the underlying object from.

ExportOptionsKit(ExportOptionsKit const &in_kit)

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

Parameters

in_kit – The source ExportOptionsKit to copy.

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!=(ExportOptionsKit const &in_kit) const

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

Parameters

in_kit – The source ExportOptionsKit to compare to this ExportOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

ExportOptionsKit &operator=(ExportOptionsKit &&in_kit)

The move assignment operator transfers the underlying object of the rvalue reference to this ExportOptionsKit.

Parameters

in_kit – An rvalue reference to an ExportOptionsKit to take the underlying object from.

Returns

A reference to this ExportOptionsKit.

ExportOptionsKit &operator=(ExportOptionsKit const &in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit – The source ExportOptionsKit to copy.

Returns

A reference to this ExportOptionsKit.

bool operator==(ExportOptionsKit const &in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters

in_kit – The source ExportOptionsKit to compare to this ExportOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

void Set(ExportOptionsKit const &in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit – The source ExportOptionsKit to copy.

ExportOptionsKit &SetDocumentToAppendTo(char const *in_filename)

Sets the PDF document to append to.

Parameters

in_filename – UTF8-encoded filename of the PDF document to append to.

Returns

A reference to this ExportOptionsKit.

void Show(ExportOptionsKit &out_kit) const

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters

out_kit – The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

bool ShowDocumentToAppendTo(UTF8 &out_filename) const

Shows the PDF document to append to setting.

Parameters

out_filename – Filename of the PDF document to append to.

Returns

true if a PDF document to append to setting was specified, false otherwise.

ExportOptionsKit &UnsetDocumentToAppendTo()

Removes the PDF document to append to setting.

Returns

A reference to this ExportOptionsKit.

ExportOptionsKit &UnsetEverything()

Removes all data from the options kit.

Returns

A reference to this ExportOptionsKit.

virtual ~ExportOptionsKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PublishExportOptionsKit