
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Image.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (HPS.Image.ExportOptionsKit in_kit) | |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.Image.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
HPS.Image.ExportOptionsKit | SetFormat (HPS.Image.Format in_format) |
Sets the format of the image. This must be specified when exporting any image. More... | |
HPS.Image.ExportOptionsKit | SetSize (uint in_width, uint in_height) |
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export. More... | |
HPS.Image.ExportOptionsKit | SetTransparentBackground (bool in_state) |
Sets whether the image background will be transparent. This setting is only valid when exporting a PNG image. More... | |
void | Show (out HPS.Image.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
bool | ShowFormat (out HPS.Image.Format out_format) |
Shows the format of the image. More... | |
bool | ShowSize (out uint out_width, out uint out_height) |
Shows the width and height (in pixels) of the image. More... | |
bool | ShowTransparentBackground (out bool out_state) |
Shows transparent background setting for this image More... | |
HPS.Image.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
HPS.Image.ExportOptionsKit | UnsetFormat () |
Removes the format of the image. More... | |
HPS.Image.ExportOptionsKit | UnsetSize () |
Removes the width and height of the image. More... | |
HPS.Image.ExportOptionsKit | UnsetTransparentBackground () |
Removes the transparent background setting of the image. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
override 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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.Image.ExportOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b) |
static bool | operator== (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.Image.ExportOptionsKit class contains options that will be used to export image files. Calling HPS.Image.ExportOptionsKit.GetDefault() will return an options kit with values found in this table.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ExportOptionsKit object.
|
inline |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ExportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
inline |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
|
inline |
Sets the format of the image. This must be specified when exporting any image.
- Parameters
-
in_format The format of the image.
- Returns
- A reference to this ExportOptionsKit.
Export format default value
|
inline |
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export.
- Parameters
-
in_width The width (in pixels) of the image. in_height The height (in pixels) of the image.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Sets whether the image background will be transparent. This setting is only valid when exporting a PNG image.
- Parameters
-
in_state Whether the image background will be transparent.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
|
inline |
Shows the format of the image.
- Parameters
-
out_format The format of the image.
- Returns
- true if the format is valid, false otherwise.
|
inline |
Shows the width and height (in pixels) of the image.
- Parameters
-
out_width The width (in pixels) of the image. out_height The height (in pixels) of the image.
- Returns
- true if the width and height are valid, false otherwise.
|
inline |
Shows transparent background setting for this image
- Parameters
-
out_state The transparent background setting for this image.
- Returns
- true if a background preference was specified, false otherwise.
|
inline |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the format of the image.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the width and height of the image.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the transparent background setting of the image.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Image.cs