hdi::core::FileFormatMessage Class Reference

Received for FileFormatGetParamsMessageType, FileFormatSetParamsMessageType, FileFormatGoMessageType, FileFormatCheckMessageType, and FileFormatUpdateMessageType. More...

#include <hdicoreMessage.h>

Inheritance diagram for hdi::core::FileFormatMessage:

Collaboration diagram for hdi::core::FileFormatMessage:

Public Types
typedef std::vector< std::shared_ptr< Artboard > >	ArtboardVector

Public Member Functions
virtual	~FileFormatMessage ()
	Destructs a FileFormatMessage object.
FileFormat *const	fileFormat () const
	Gets the FileFormat object to which the message applies.
FileFormat::Options	operation () const
	Gets the requested operation.
FileFormat::ExtendedOptions	extendedOperation () const
	Gets the requested extended operation.
std::string	filePath () const
	Gets the path of the file to read, write, check, etc.
void	setFilePath (const std::string &path_)
	Sets the path of the file to read, write, check, etc.
void *	actionParam () const
	Gets the additional parameter data, if the ContainsPartialParametersOption is set in the return value of the operation() method.
ArtboardVector	artboards () const
	If the extended operation is SaveMultiArtboardsExtendedOption, this gets the artboards affected by the file format message.
Public Member Functions inherited from hdi::core::Message
virtual	~Message ()
	Destructs a Message object.
virtual MessageType	type () const
	Gets the type of message data the target object represents.
virtual void *	rawData () const
	Gets the raw Illustrator message data struct.

Friends
class	Dispatcher

Additional Inherited Members
Protected Member Functions inherited from hdi::core::Message
	Message ()
	Internal use only.
	Message (const Message &)
	Unused.
Message &	operator= (const Message &)
	Unused.
Protected Attributes inherited from hdi::core::Message
void *	_data
	Stores private implementation data.

Detailed Description

Received for FileFormatGetParamsMessageType, FileFormatSetParamsMessageType, FileFormatGoMessageType, FileFormatCheckMessageType, and FileFormatUpdateMessageType.

Constructor & Destructor Documentation

~FileFormatMessage()

virtual hdi::core::FileFormatMessage::~FileFormatMessage ( )

virtual

Destructs a FileFormatMessage object.

Author

GW

Date

08/2013

Member Function Documentation

actionParam()

void * hdi::core::FileFormatMessage::actionParam

(

)

const

Gets the additional parameter data, if the ContainsPartialParametersOption is set in the return value of the operation() method.

Author

GW

Date

12/2014

Returns

Additional file format data

artboards()

ArtboardVector hdi::core::FileFormatMessage::artboards

(

)

const

If the extended operation is SaveMultiArtboardsExtendedOption, this gets the artboards affected by the file format message.

Author

GW

Date

12/2014

Returns

A vector of artboards for the message

extendedOperation()

FileFormat::ExtendedOptions hdi::core::FileFormatMessage::extendedOperation

(

)

const

Gets the requested extended operation.

Author

GW

Date

12/2014

Returns

A bitwise OR of the enum values for the file format extended operation

fileFormat()

FileFormat *const hdi::core::FileFormatMessage::fileFormat

(

)

const

Gets the FileFormat object to which the message applies.

Author

GW

Date

12/2014

Returns

The intended file format

filePath()

std::string hdi::core::FileFormatMessage::filePath

(

)

const

Gets the path of the file to read, write, check, etc.

Author

GW

Date

12/2014

Returns

File path for the format message, as UTF-8

operation()

FileFormat::Options hdi::core::FileFormatMessage::operation

(

)

const

Gets the requested operation.

Author

GW

Date

12/2014

Returns

A bitwise OR of the enum values for the file format operation

setFilePath()

void hdi::core::FileFormatMessage::setFilePath

(

const std::string &

path_

)

Sets the path of the file to read, write, check, etc.

Author

GW

Date

12/2014

Parameters

path_

New file path for the format message, as UTF-8