Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Types | Public Member Functions | Friends | List of all members
hdi::core::FileFormatMessage Class Reference

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

#include <hdicoreMessage.h>

Inheritance diagram for hdi::core::FileFormatMessage:
Inheritance graph
[legend]
Collaboration diagram for hdi::core::FileFormatMessage:
Collaboration graph
[legend]

Public Types

typedef std::vector< Artboard * > ArtboardVector
 

Public Member Functions

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

Friends

class Dispatcher
 

Additional Inherited Members

- Protected Member Functions inherited from hdi::core::Message
 Message ()
 Internal use only. More...
 
 Message (const Message &)
 Unused. More...
 
Messageoperator= (const Message &)
 Unused. More...
 
- 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

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

Destructs a FileFormatMessage object.

Author
GW
Date
08/2013

Member Function Documentation

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
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
Warning
The caller assumes responsibility for the memory of the contained Artboard objects.
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* 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
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
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
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