#include <sprk_publish.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_kit) | |
HPS::Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetDocumentToAppendTo (char const *in_filename) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowDocumentToAppendTo (UTF8 &out_filename) const |
ExportOptionsKit & | UnsetDocumentToAppendTo () |
ExportOptionsKit & | UnsetEverything () |
![]() | |
Sprocket (HPS::Sprocket const &in_that)=default | |
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 () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The ExportOptionsKit class is a user space object. It contains settings controlling how 3D PDF data is exported via Publish.
HPS::Publish::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS::Publish::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
HPS::Publish::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_kit | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying object of the rvalue reference to this ExportOptionsKit.
in_kit | An rvalue reference to an ExportOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Publish::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::Publish::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportOptionsKit.
in_kit | An rvalue reference to an ExportOptionsKit to take the underlying object from. |
bool HPS::Publish::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
void HPS::Publish::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
ExportOptionsKit& HPS::Publish::ExportOptionsKit::SetDocumentToAppendTo | ( | char const * | in_filename | ) |
Sets the PDF document to append to.
in_filename | UTF8-encoded filename of the PDF document to append to. |
void HPS::Publish::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The ExportOptionsKit to populate with the contents of this ExportOptionsKit. |
bool HPS::Publish::ExportOptionsKit::ShowDocumentToAppendTo | ( | UTF8 & | out_filename | ) | const |
Shows the PDF document to append to setting.
out_filename | Filename of the PDF document to append to. |
ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetDocumentToAppendTo | ( | ) |
Removes the PDF document to append to setting.
ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all data from the options kit.