AIPlaceRequestData Struct Reference

Request data for AIPlacedSuite::ExecPlaceRequest(). More...

#include <AIPlaced.h>

List of all members.

Public Member Functions
	AIPlaceRequestData ()
Public Attributes
ai::int32	m_lPlaceMode
	The type of placement request, a PlaceRequestMode constant which determines what operation is performed.
AIArtHandle	m_hOldArt
	Art to be replaced.
AIArtHandle	m_hNewArt
	Returns the handle for new art that was placed or created.
const ai::FilePath *	m_pFilePath
	File path of the placed file.
ai::int32	m_lParam
	The type of art to create for the kCreateNewArt request, an AIArtType value.
ai::int16	m_filemethod
	0 to place or import the file, 1 to link the file.
ASBoolean	m_disableTemplate
	True to disable the Template placement option.
AIBoolean	m_doShowParamDialog
	True to show the parameters dialog even when the file path is known.
AIPlaceTransformType	m_PlaceTransformType
	to trigger what kind of placement you want

---

Detailed Description

Request data for AIPlacedSuite::ExecPlaceRequest().

Initialize all fields, even when not expecting to use them.

---

Constructor & Destructor Documentation

AIPlaceRequestData::AIPlaceRequestData

(

)

[inline]

---

Member Data Documentation

ASBoolean AIPlaceRequestData::m_disableTemplate

True to disable the Template placement option.

AIBoolean AIPlaceRequestData::m_doShowParamDialog

True to show the parameters dialog even when the file path is known.

ai::int16 AIPlaceRequestData::m_filemethod

0 to place or import the file, 1 to link the file.

AIArtHandle AIPlaceRequestData::m_hNewArt

Returns the handle for new art that was placed or created.

AIArtHandle AIPlaceRequestData::m_hOldArt

Art to be replaced.

ai::int32 AIPlaceRequestData::m_lParam

The type of art to create for the kCreateNewArt request, an AIArtType value.

ai::int32 AIPlaceRequestData::m_lPlaceMode

The type of placement request, a PlaceRequestMode constant which determines what operation is performed.

const ai::FilePath* AIPlaceRequestData::m_pFilePath

File path of the placed file.

If NULL, shows a File Place dialog to query the user for the path and any relevant placement options.

AIPlaceTransformType AIPlaceRequestData::m_PlaceTransformType

to trigger what kind of placement you want

---

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

• AIPlaced.h