CATDibModelerUseItf Interface CATIDibFormatsManager

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDibFormatsManager

Role: CATIDibFormatsManager is an interface dedicated to manage formats on Sheets.

Method Index

o AddCustomFormat(CATUnicodeString&,CATIDibCustomFormat*&,IUnknown*): Creates and adds to the representation a custom format oCustomFormat named iName.
o GetAvailableFormats(CATListValCATBaseUnknown_var&): Appends to ioFormats the formats available on the sheet.
o GetCustomFormats(CATListValCATBaseUnknown_var&): Appends to iFormats the custom formats.
o GetStandardFormats(CATListValCATBaseUnknown_var&): Appends to ioFormats the standard formats.
o RemoveCustomFormat(CATIDibCustomFormat*): Removes the custom format iCustomFormat from the representation.
o SetOrientationsTypeOnCustomFormat(CATIDibCustomFormat*,CATFormatOrientationsType,CATListValCATBaseUnknown_var*): Sets the format orientations type for iCustomFormat to iOrientsType.

Methods

o AddCustomFormat

public virtual AddCustomFormat(	const	`iName`,
		`oCustomFormat`,
		`iFormat`	`= NULL`)

Creates and adds to the representation a custom format oCustomFormat named iName.

Parameters:

const: CATUnicodeString & [in] The name of the new format.
CATIDibCustomFormat*: &oCustomFormat [out] The created format.
IUnknown: * iFormat [in] If not NULL, a format already in the representation whose caracteristics will be used to initialize oCustomFormat. If NULL the default format will be used to initialize oCustomFormat.

o GetAvailableFormats

public virtual GetAvailableFormats( ioFormats)

Appends to ioFormats the formats available on the sheet.

Parameters:

CATLISTP(CATIDibFormat): &ioFormats [in out] The list the formats will be appended to.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error.

o GetCustomFormats

public virtual GetCustomFormats( ioCustomFormats)

Appends to iFormats the custom formats.

Parameters:

CATListValCATBaseUnknown_var: &ioCustomFormats [in out] The list the formats will be appended to.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error.

o GetStandardFormats

public virtual GetStandardFormats( ioStdFormats)

Appends to ioFormats the standard formats.

Parameters:

CATListValCATBaseUnknown_var: &ioStdFormats [in out] The list the formats will be appended to.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error.

o RemoveCustomFormat

public virtual RemoveCustomFormat( iCustomFormat)

Removes the custom format iCustomFormat from the representation.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error or iCustomFormat can not be removed because there is at least one sheet.

o SetOrientationsTypeOnCustomFormat

public virtual SetOrientationsTypeOnCustomFormat(	`iCustomFormat`,
	`iOrientsType`,
	`ioModifiedSheets`	`= NULL`)

Sets the format orientations type for iCustomFormat to iOrientsType. Also updates the sheets associated with iCustomFormat if their orientation is not compliant with iOrientsType.

Parameters:

CATIDibCustomFormat: *iCustomFormat [in] The format whose orientations type must be changed.
CATFormatOrientationsType: iOrientsType [in] The new orientations types for iCustomFormat.
CATListValCATBaseUnknown_var: *ioModifiedSheet= NULL [in out] If not NULL, pointers to the sheets which were modified during the operation will be appended to ioModifiedSheet. Don't forget to release the pointers.

Returns:

HRESULT

S_OK: Success.
S_FALSE: Some sheets were not compliant with the new orientation types. Consequently their orientation has been modified.
E_FAIL: Error.

This object is included in the file: CATIDibFormatsManager.h
If needed, your Imakefile.mk should include the module: CATDibModelerUseItf