API Search || Global Search
HPS::Publish::ExportOptionsKit Class Reference

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ExportOptionsKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

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
 
ExportOptionsKitoperator= (ExportOptionsKit const &in_kit)
 
ExportOptionsKitoperator= (ExportOptionsKit &&in_kit)
 
bool operator== (ExportOptionsKit const &in_kit) const
 
void Set (ExportOptionsKit const &in_kit)
 
ExportOptionsKitSetDocumentToAppendTo (char const *in_filename)
 
void Show (ExportOptionsKit &out_kit) const
 
bool ShowDocumentToAppendTo (UTF8 &out_filename) const
 
ExportOptionsKitUnsetDocumentToAppendTo ()
 
ExportOptionsKitUnsetEverything ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishExportOptionsKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

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.

Parameters
in_kitThe 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.

Parameters
in_kitAn rvalue reference to an ExportOptionsKit to take the underlying object from.

Member Function Documentation

bool HPS::Publish::ExportOptionsKit::Empty ( ) const
virtual

Indicates whether this ExportOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

bool HPS::Publish::ExportOptionsKit::Equals ( ExportOptionsKit const &  in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::Publish::ExportOptionsKit::operator!= ( ExportOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.
ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator= ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.
Returns
A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator= ( ExportOptionsKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to an ExportOptionsKit to take the underlying object from.
Returns
A reference to this ExportOptionsKit.
bool HPS::Publish::ExportOptionsKit::operator== ( ExportOptionsKit const &  in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::Publish::ExportOptionsKit::Set ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.
ExportOptionsKit& HPS::Publish::ExportOptionsKit::SetDocumentToAppendTo ( char const *  in_filename)

Sets the PDF document to append to.

Parameters
in_filenameUTF8-encoded filename of the PDF document to append to.
Returns
A reference to this ExportOptionsKit.
void HPS::Publish::ExportOptionsKit::Show ( ExportOptionsKit out_kit) const

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe 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.

Parameters
out_filenameFilename of the PDF document to append to.
Returns
true if a PDF document to append to setting was specified, false otherwise.
ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetDocumentToAppendTo ( )

Removes the PDF document to append to setting.

Returns
A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetEverything ( )

Removes all data from the options kit.

Returns
A reference to this ExportOptionsKit.

The documentation for this class was generated from the following file: