The HPS::Image::ExportOptionsKit class contains options that will be used to export image files. More...

#include <hps.h>

Inheritance diagram for HPS::Image::ExportOptionsKit:

Collaboration diagram for HPS::Image::ExportOptionsKit:

Public Member Functions
	ExportOptionsKit ()
	The default constructor creates an empty ExportOptionsKit object. More...

	ExportOptionsKit (ExportOptionsKit const &in_kit)
	The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More...

	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. More...

ExportOptionsKit &	operator= (ExportOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy. More...

virtual	~ExportOptionsKit ()

HPS::Type	ObjectType () const

void	Set (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...

void	Show (ExportOptionsKit &out_kit) const
	Copies this ExportOptionsKit into the given ExportOptionsKit. More...

ExportOptionsKit &	operator= (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...

bool	Empty () const
	Indicates whether this ExportOptionsKit has any values set on it. More...

bool	Equals (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...

bool	operator== (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...

bool	operator!= (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit. More...

ExportOptionsKit &	SetSize (unsigned int in_width, unsigned int in_height)
	Sets the width and height (in pixels) of the image. More...

ExportOptionsKit &	SetFormat (Image::Format in_format)
	Sets the format of the image. More...

ExportOptionsKit &	SetTransparentBackground (bool in_state)
	Sets whether the image background will be transparent. More...

ExportOptionsKit &	UnsetSize ()
	Removes the width and height of the image. More...

ExportOptionsKit &	UnsetFormat ()
	Removes the format of the image. More...

ExportOptionsKit &	UnsetTransparentBackground ()
	Removes the transparent background setting of the image. More...

ExportOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportOptionsKit. More...

bool	ShowSize (unsigned int &out_width, unsigned int &out_height) const
	Shows the width and height (in pixels) of the image. More...

bool	ShowFormat (Image::Format &out_format) const
	Shows the format of the image. More...

bool	ShowTransparentBackground (bool &out_state) const
	Shows transparent background setting for this image. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static ExportOptionsKit	GetDefault ()
	Creates a ExportOptionsKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ImageExportOptionsKit

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

◆ ExportOptionsKit() [1/3]

HPS::Image::ExportOptionsKit::ExportOptionsKit ( )

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/3]

HPS::Image::ExportOptionsKit::ExportOptionsKit ( ExportOptionsKit const & in_kit )

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.

◆ ExportOptionsKit() [3/3]

HPS::Image::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

in_that An rvalue reference to an ExportOptionsKit to take the impl from.

◆ ~ExportOptionsKit()

virtual HPS::Image::ExportOptionsKit::~ExportOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::Image::ExportOptionsKit::Empty ( ) const

virtual

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.

◆ Equals()

bool HPS::Image::ExportOptionsKit::Equals ( ExportOptionsKit const & in_kit ) const

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.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static ExportOptionsKit HPS::Image::ExportOptionsKit::GetDefault ( )

static

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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::Image::ExportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::Image::ExportOptionsKit::operator!= ( ExportOptionsKit const & in_kit ) const

Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.

Parameters

in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ExportOptionsKit& HPS::Image::ExportOptionsKit::operator= ( ExportOptionsKit && in_that )

The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.

Parameters

in_that An rvalue reference to an ExportOptionsKit to take the impl from.

Returns: A reference to this ExportOptionsKit.

◆ operator=() [2/2]

ExportOptionsKit& HPS::Image::ExportOptionsKit::operator= ( ExportOptionsKit const & in_kit )

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit The source ExportOptionsKit to copy.

Returns: A reference to this ExportOptionsKit.

◆ operator==()

bool HPS::Image::ExportOptionsKit::operator== ( ExportOptionsKit const & in_kit ) const

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.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::Image::ExportOptionsKit::Set ( ExportOptionsKit const & in_kit )

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit The source ExportOptionsKit to copy.

◆ SetFormat()

ExportOptionsKit& HPS::Image::ExportOptionsKit::SetFormat ( Image::Format in_format )

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.

See also: Export format default value

◆ SetSize()

ExportOptionsKit& HPS::Image::ExportOptionsKit::SetSize	(	unsigned int	in_width,
		unsigned int	in_height
	)

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.

◆ SetTransparentBackground()

ExportOptionsKit& 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.

Parameters

in_state Whether the image background will be transparent.

Returns: A reference to this ExportOptionsKit.

◆ Show()

void HPS::Image::ExportOptionsKit::Show ( ExportOptionsKit & out_kit ) const

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters

out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

◆ ShowFormat()

bool HPS::Image::ExportOptionsKit::ShowFormat ( Image::Format & out_format ) const

Shows the format of the image.

Parameters

out_format The format of the image.

Returns: true if the format is valid, false otherwise.

◆ ShowSize()

bool HPS::Image::ExportOptionsKit::ShowSize	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

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.

◆ ShowTransparentBackground()

bool HPS::Image::ExportOptionsKit::ShowTransparentBackground ( bool & out_state ) const

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.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetEverything()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetEverything ( )

Removes all settings from this ExportOptionsKit.

Returns: A reference to this ExportOptionsKit.

◆ UnsetFormat()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetFormat ( )

Removes the format of the image.

Returns: A reference to this ExportOptionsKit.

◆ UnsetSize()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetSize ( )

Removes the width and height of the image.

Returns: A reference to this ExportOptionsKit.

◆ UnsetTransparentBackground()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetTransparentBackground ( )

Removes the transparent background setting of the image.

Returns: A reference to this ExportOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Image::ExportOptionsKit::staticType = HPS::Type::ImageExportOptionsKit

static

The documentation for this class was generated from the following file:

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExportOptionsKit() [1/3]

◆ ExportOptionsKit() [2/3]

◆ ExportOptionsKit() [3/3]

◆ ~ExportOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetFormat()

◆ SetSize()

◆ SetTransparentBackground()

◆ Show()

◆ ShowFormat()

◆ ShowSize()

◆ ShowTransparentBackground()

◆ Type()

◆ UnsetEverything()

◆ UnsetFormat()

◆ UnsetSize()

◆ UnsetTransparentBackground()

Member Data Documentation

◆ staticType