#include <hps.h>
The HPS::Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. Calling HPS::Hardcopy::File::ExportOptionsKit::GetDefault() will return an options kit with values found in here.
HPS::Hardcopy::File::ExportOptionsKit::ExportOptionsKit |
( |
| ) |
|
HPS::Hardcopy::File::ExportOptionsKit::ExportOptionsKit |
( |
ExportOptionsKit const & |
in_kit | ) |
|
HPS::Hardcopy::File::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.
- Parameters
-
bool HPS::Hardcopy::File::ExportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
bool HPS::Hardcopy::File::ExportOptionsKit::Equals |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
Creates a ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A ExportOptionsKit with the default settings.
HPS::Type HPS::Hardcopy::File::ExportOptionsKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::Hardcopy::File::ExportOptionsKit::operator!= |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ExportOptionsKit.
bool HPS::Hardcopy::File::ExportOptionsKit::operator== |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
void HPS::Hardcopy::File::ExportOptionsKit::Set |
( |
ExportOptionsKit const & |
in_kit | ) |
|
Sets the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
in_resolution | Resolution (dots per inch or dots per centimeter). |
in_units | Units of preceding arguments. Defaults to Inches. |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
Sets the size of the image to be inserted into the Hardcopy.
- Parameters
-
in_width | Width in inches. |
in_height | Height in inches. |
in_units | Units of preceding arguments. Defaults to Inches |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::SetWYSIWYG |
( |
bool |
in_onoff | ) |
|
Enables or disables WYSIWYG hardcopy output. The WYSIWYG setting (which stands for What You See Is What You Get) works as follows:
-
If true, what you see on the screen is what will be printed. This is the default.
-
If false, everything which will fit on the page size you have specified will be printed, even if some of that is not on screen when you issue the command.
- Parameters
-
in_onoff | true is on, false is off. |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
void HPS::Hardcopy::File::ExportOptionsKit::Show |
( |
ExportOptionsKit & |
out_kit | ) |
const |
bool HPS::Hardcopy::File::ExportOptionsKit::ShowResolution |
( |
float & |
out_resolution, |
|
|
Hardcopy::ResolutionUnits & |
out_units |
|
) |
| const |
Shows the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
out_resolution | Resolution (dots per inch or dots per centimeter). |
out_units | Units of preceding arguments. |
- Returns
- true if a size setting was specified, false otherwise.
bool HPS::Hardcopy::File::ExportOptionsKit::ShowSize |
( |
float & |
out_width, |
|
|
float & |
out_height, |
|
|
Hardcopy::SizeUnits & |
out_units |
|
) |
| const |
Shows the size of the image to be inserted into the Hardcopy.
- Parameters
-
out_width | Width. |
out_height | Height. |
out_units | Units of preceding arguments. |
- Returns
- true if a size setting was specified, false otherwise.
bool HPS::Hardcopy::File::ExportOptionsKit::ShowWYSIWYG |
( |
bool & |
out_onoff | ) |
const |
Shows true if wysiwyg has been enabled
- Returns
- true if a size setting was specified, false otherwise.
The documentation for this class was generated from the following file:
- C:/git/visualize/hps/include/hps.h