#include <sprk_publish.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ImageKit const &in_kit) const |
ImageKit () | |
ImageKit (ImageKit const &in_kit) | |
ImageKit (ImageKit &&in_kit) | |
HPS::Type | ObjectType () const |
bool | operator!= (ImageKit const &in_kit) const |
ImageKit & | operator= (ImageKit const &in_kit) |
ImageKit & | operator= (ImageKit &&in_kit) |
bool | operator== (ImageKit const &in_kit) const |
void | Set (ImageKit const &in_kit) |
ImageKit & | SetFile (char const *in_filename) |
ImageKit & | SetFormat (Image::Format in_format) |
ImageKit & | SetSize (int in_width, int in_height) |
void | Show (ImageKit &out_kit) const |
bool | ShowFile (UTF8 &out_filename) const |
bool | ShowFormat (Image::Format &out_format) const |
bool | ShowSize (int &out_width, int &out_height) const |
ImageKit & | UnsetEverything () |
ImageKit & | UnsetFile () |
ImageKit & | UnsetFormat () |
ImageKit & | UnsetSize () |
![]() | |
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 () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishImageKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The ImageKit class is a user space object. It acts as the container for all data that can be used to specify an image for a Publish PDF.
Constructor & Destructor Documentation
HPS::Publish::ImageKit::ImageKit | ( | ) |
The default constructor creates an empty ImageKit object.
HPS::Publish::ImageKit::ImageKit | ( | ImageKit const & | in_kit | ) |
HPS::Publish::ImageKit::ImageKit | ( | ImageKit && | in_kit | ) |
Member Function Documentation
|
virtual |
Indicates whether this ImageKit has any values set on it.
- Returns
- true if no values are set on this ImageKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::Publish::ImageKit::Equals | ( | ImageKit const & | in_kit | ) | const |
bool HPS::Publish::ImageKit::operator!= | ( | ImageKit const & | in_kit | ) | const |
bool HPS::Publish::ImageKit::operator== | ( | ImageKit const & | in_kit | ) | const |
void HPS::Publish::ImageKit::Set | ( | ImageKit const & | in_kit | ) |
ImageKit& HPS::Publish::ImageKit::SetFile | ( | char const * | in_filename | ) |
Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.
- Parameters
-
in_filename UTF8-encoded filename for the image.
- Returns
- A reference to this ImageKit.
ImageKit& HPS::Publish::ImageKit::SetFormat | ( | Image::Format | in_format | ) |
Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.
- Parameters
-
in_format The format of the image.
- Returns
- A reference to this ImageKit.
ImageKit& HPS::Publish::ImageKit::SetSize | ( | int | in_width, |
int | in_height | ||
) |
Sets the size of the image in pixels. This corresponds to the value that will be passed to A3DPDFImageData::m_iWidth and A3DPDFImageData::m_iHeight.
- Parameters
-
in_width The width of the image in pixels. in_height The height of the image in pixels.
- Returns
- A reference to this ImageKit.
void HPS::Publish::ImageKit::Show | ( | ImageKit & | out_kit | ) | const |
bool HPS::Publish::ImageKit::ShowFile | ( | UTF8 & | out_filename | ) | const |
Shows the file setting.
- Parameters
-
out_filename The filename for the image.
- Returns
- true if a color was specified, false otherwise.
bool HPS::Publish::ImageKit::ShowFormat | ( | Image::Format & | out_format | ) | const |
Shows the format setting.
- Parameters
-
out_format The format of the image.
- Returns
- true if a format was specified, false otherwise.
bool HPS::Publish::ImageKit::ShowSize | ( | int & | out_width, |
int & | out_height | ||
) | const |
Shows the size setting.
- Parameters
-
out_width The width of the image in pixels. out_height The height of the image in pixels.
- Returns
- true if a width and height were specified, false otherwise.
ImageKit& HPS::Publish::ImageKit::UnsetEverything | ( | ) |
Removes all data from the image.
- Returns
- A reference to this ImageKit.
ImageKit& HPS::Publish::ImageKit::UnsetFile | ( | ) |
Removes the file from the image.
- Returns
- A reference to this ImageKit.
ImageKit& HPS::Publish::ImageKit::UnsetFormat | ( | ) |
Removes the format from the image.
- Returns
- A reference to this ImageKit.
ImageKit& HPS::Publish::ImageKit::UnsetSize | ( | ) |
Removes the size from the image.
- Returns
- A reference to this ImageKit.
The documentation for this class was generated from the following file:
- include/sprk_publish.h