REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_that) |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetResolution (float in_resolution) |
ExportOptionsKit & | SetWYSIWYG (bool in_onoff) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowResolution (float &out_resolution) const |
bool | ShowWYSIWYG (bool &out_onoff) const |
ExportOptionsKit & | UnsetEverything () |
ExportOptionsKit & | UnsetResolution () |
ExportOptionsKit & | UnsetWYSIWYG () |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The ExportOptionsKit class contains settings controlling hardcopy export.
Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
Hardcopy::GDI::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. |
Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_that | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from Object.
bool Hardcopy::GDI::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 Object.
bool Hardcopy::GDI::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& Hardcopy::GDI::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
ExportOptionsKit& Hardcopy::GDI::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
bool Hardcopy::GDI::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 Hardcopy::GDI::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
ExportOptionsKit& Hardcopy::GDI::ExportOptionsKit::SetResolution | ( | float | in_resolution | ) |
Sets the resolution of the image to be inserted into the Hardcopy.
in_resolution | Resolution in specified units (dots per unit). |
ExportOptionsKit& Hardcopy::GDI::ExportOptionsKit::SetWYSIWYG | ( | bool | in_onoff | ) |
Enables or disables wysiwyg hardcopy output
onoff | true is on, false is off |
void Hardcopy::GDI::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 Hardcopy::GDI::ExportOptionsKit::ShowResolution | ( | float & | out_resolution | ) | const |
Shows the resolution of the image to be inserted into the Hardcopy.
out_resolution | Resolution in specified units (dots per unit). |
bool Hardcopy::GDI::ExportOptionsKit::ShowWYSIWYG | ( | bool & | out_onoff | ) | const |
Shows true if wysiwyg has been enabled
ExportOptionsKit& Hardcopy::GDI::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
ExportOptionsKit& Hardcopy::GDI::ExportOptionsKit::UnsetResolution | ( | ) |
Removes the resolution of the image to be inserted into the Hardcopy.
ExportOptionsKit& Hardcopy::GDI::ExportOptionsKit::UnsetWYSIWYG | ( | ) |
Removes the wysiwyg setting from Hardcopy.