Inheritance diagram for HPS.Publish.ImageKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.ImageKit in_kit)
 
override int GetHashCode ()
 
 ImageKit ()
 
 ImageKit (HPS.Publish.ImageKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.ImageKit in_kit)
 
HPS.Publish.ImageKit SetFile (string in_filename)
 
HPS.Publish.ImageKit SetFormat (HPS.Publish.Image.Format in_format)
 
HPS.Publish.ImageKit SetSize (int in_width, int in_height)
 
void Show (out HPS.Publish.ImageKit out_kit)
 
bool ShowFile (out string out_filename)
 
bool ShowFormat (out HPS.Publish.Image.Format out_format)
 
bool ShowSize (out int out_width, out int out_height)
 
HPS.Publish.ImageKit UnsetEverything ()
 
HPS.Publish.ImageKit UnsetFile ()
 
HPS.Publish.ImageKit UnsetFormat ()
 
HPS.Publish.ImageKit UnsetSize ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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]

HPS.Publish.ImageKit.ImageKit ( )
inline

The default constructor creates an empty ImageKit object.

◆ ImageKit() [2/2]

HPS.Publish.ImageKit.ImageKit ( HPS.Publish.ImageKit  in_kit)
inline

The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.

Parameters
in_kitThe source ImageKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.ImageKit.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()

bool HPS.Publish.ImageKit.Equals ( HPS.Publish.ImageKit  in_kit)
inline

Check if the source ImageKit is equivalent to this ImageKit.

Parameters
in_kitThe source ImageKit to compare to this ImageKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.Publish.ImageKit.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()

void HPS.Publish.ImageKit.Set ( HPS.Publish.ImageKit  in_kit)
inline

Copies the source ImageKit into this ImageKit.

Parameters
in_kitThe source ImageKit to copy.

◆ SetFile()

HPS.Publish.ImageKit HPS.Publish.ImageKit.SetFile ( string  in_filename)
inline

Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.

Parameters
in_filenameUTF8-encoded filename for the image.
Returns
A reference to this ImageKit.

◆ SetFormat()

HPS.Publish.ImageKit HPS.Publish.ImageKit.SetFormat ( HPS.Publish.Image.Format  in_format)
inline

Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImageKit.

◆ SetSize()

HPS.Publish.ImageKit HPS.Publish.ImageKit.SetSize ( int  in_width,
int  in_height 
)
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_widthThe width of the image in pixels.
in_heightThe height of the image in pixels.
Returns
A reference to this ImageKit.

◆ Show()

void HPS.Publish.ImageKit.Show ( out HPS.Publish.ImageKit  out_kit)
inline

Copies this ImageKit into the given ImageKit.

Parameters
out_kitThe ImageKit to populate with the contents of this ImageKit.

◆ ShowFile()

bool HPS.Publish.ImageKit.ShowFile ( out string  out_filename)
inline

Shows the file setting.

Parameters
out_filenameThe filename for the image.
Returns
true if a color was specified, false otherwise.

◆ ShowFormat()

bool HPS.Publish.ImageKit.ShowFormat ( out HPS.Publish.Image.Format  out_format)
inline

Shows the format setting.

Parameters
out_formatThe format of the image.
Returns
true if a format was specified, false otherwise.

◆ ShowSize()

bool HPS.Publish.ImageKit.ShowSize ( out int  out_width,
out int  out_height 
)
inline

Shows the size setting.

Parameters
out_widthThe width of the image in pixels.
out_heightThe height of the image in pixels.
Returns
true if a width and height were specified, false otherwise.

◆ UnsetEverything()

HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetEverything ( )
inline

Removes all data from the image.

Returns
A reference to this ImageKit.

◆ UnsetFile()

HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetFile ( )
inline

Removes the file from the image.

Returns
A reference to this ImageKit.

◆ UnsetFormat()

HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetFormat ( )
inline

Removes the format from the image.

Returns
A reference to this ImageKit.

◆ UnsetSize()

HPS.Publish.ImageKit HPS.Publish.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