Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Public Attributes | List of all members
hdi::core::FileFormat::AddData Struct Reference

Wraps information needed to add a new file format. More...

#include <hdicoreFileFormat.h>

Public Member Functions

 AddData ()
 AddData constructor, setting default values for all members. More...
 
 AddData (const AddData &d_)
 AddData copy constructor, copying values from an existing AddData object. More...
 
virtual ~AddData ()
 AddData destructor. More...
 
AddDataoperator= (const AddData &rhs_)
 Overloaded assignment operator, copying values from one AddData object to another. More...
 

Public Attributes

int32_t type
 Mac 4-char code file identifier. Plug-ins on Windows can ignore this.
 
std::string title
 Description string to be shown in Illustrator's Save and Open dialogs, as UTF-8.
 
int32_t titleOrder
 Indicates the order of file format menu items, if the plug-in registers more than one. More...
 
ExtVector extensions
 Lists the DOS-style file extensions that are filtered in the Open dialog or appended to the file name in the Save dialog. More...
 

Detailed Description

Wraps information needed to add a new file format.

Constructor & Destructor Documentation

hdi::core::FileFormat::AddData::AddData ( )

AddData constructor, setting default values for all members.

Author
GW
Date
02/2015
hdi::core::FileFormat::AddData::AddData ( const AddData d_)

AddData copy constructor, copying values from an existing AddData object.

Author
GW
Date
02/2015
Parameters
d_Existing AddData object
virtual hdi::core::FileFormat::AddData::~AddData ( )
virtual

AddData destructor.

Author
GW
Date
02/2015

Member Function Documentation

AddData& hdi::core::FileFormat::AddData::operator= ( const AddData rhs_)

Overloaded assignment operator, copying values from one AddData object to another.

Author
GW
Date
02/2015
Parameters
rhs_Righthand side of the assignment
Returns
The lefthand side of the assignment, but with its values updated

Member Data Documentation

ExtVector hdi::core::FileFormat::AddData::extensions

Lists the DOS-style file extensions that are filtered in the Open dialog or appended to the file name in the Save dialog.

Note
Each extension can be up to 5 characters in length, and a total of five 5-char extensions are supported (or six 4-char extensions, or eight 3-char extensions, or ten 2-char extensions, or sixteen 1-char extensions). Any combination of extension lengths can be mixed, but their total length cannot exceed 31 characters combined (minus a single-character internal delimeter that is used between each extension).
int32_t hdi::core::FileFormat::AddData::titleOrder

Indicates the order of file format menu items, if the plug-in registers more than one.

Note
Use 0 if only registering a single file format.