
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImageKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.ImageKit in_kit) |
Check if the source ImageKit is equivalent to this ImageKit. More... | |
override int | GetHashCode () |
ImageKit () | |
The default constructor creates an empty ImageKit object. More... | |
ImageKit (HPS.Publish.ImageKit in_kit) | |
The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More... | |
void | Set (HPS.Publish.ImageKit in_kit) |
Copies the source ImageKit into this ImageKit. More... | |
HPS.Publish.ImageKit | SetFile (string in_filename) |
Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName. More... | |
HPS.Publish.ImageKit | SetFormat (HPS.Publish.Image.Format in_format) |
Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat. More... | |
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. More... | |
void | Show (out HPS.Publish.ImageKit out_kit) |
Copies this ImageKit into the given ImageKit. More... | |
bool | ShowFile (out string out_filename) |
Shows the file setting. More... | |
bool | ShowFormat (out HPS.Publish.Image.Format out_format) |
Shows the format setting. More... | |
bool | ShowSize (out int out_width, out int out_height) |
Shows the size setting. More... | |
HPS.Publish.ImageKit | UnsetEverything () |
Removes all data from the image. More... | |
HPS.Publish.ImageKit | UnsetFile () |
Removes the file from the image. More... | |
HPS.Publish.ImageKit | UnsetFormat () |
Removes the format from the image. More... | |
HPS.Publish.ImageKit | UnsetSize () |
Removes the size from the image. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b) |
static bool | operator== (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
◆ ImageKit() [1/2]
|
inline |
The default constructor creates an empty ImageKit object.
◆ ImageKit() [2/2]
|
inline |
Member Function Documentation
◆ Empty()
|
inlinevirtual |
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.
◆ Equals()
|
inline |
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
◆ Set()
|
inline |
◆ SetFile()
|
inline |
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.
◆ SetFormat()
|
inline |
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.
◆ SetSize()
|
inline |
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.
◆ Show()
|
inline |
◆ ShowFile()
|
inline |
Shows the file setting.
- Parameters
-
out_filename The filename for the image.
- Returns
- true if a color was specified, false otherwise.
◆ ShowFormat()
|
inline |
Shows the format setting.
- Parameters
-
out_format The format of the image.
- Returns
- true if a format was specified, false otherwise.
◆ ShowSize()
|
inline |
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.
◆ UnsetEverything()
|
inline |
Removes all data from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetFile()
|
inline |
Removes the file from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetFormat()
|
inline |
Removes the format from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetSize()
|
inline |
Removes the size from the image.
- Returns
- A reference to this ImageKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs