Functions for integrating into the publisher or registering new supported file types.
More...
|
| typedef GSErrCode | SaveWithOptionProc(API_SaveMethod method, const char *path, API_UserData *userData, GS::UniString *reportStr) |
| | Callback function to save the document with set options in the newly registered publish format.
|
| |
| typedef GSErrCode | SaveWithTranslatorProc(API_SaveMethod method, const char *path, API_TranslatorNameConfig translator, GS::UniString *reportStr) |
| | Callback function to save the document with a translator in the newly registered publish format.
|
| |
| typedef GSErrCode | SaveOptionProc(API_SaveMethod method, API_UserData *userData) |
| | Callback function to set different options for the newly registered format.
|
| |
| typedef GSErrCode | SaveTranslatorProc(API_SaveMethod method, API_TranslatorNameConfig &translator) |
| | Callback function to set the translator configuration for the newly registered format.
|
| |
| typedef GSErrCode | SaveInitialOptionProc(API_SaveMethod method, API_UserData *userData) |
| | Callback function to set initial options for the newly registered format.
|
| |
| typedef GSErrCode | TranslatorGetterProc(GS::Array< API_TranslatorNameConfig > &arr) |
| | Callback function to receive the translators for the new registered publish forma.
|
| |
| typedef GSErrCode | DefaultTranslatorGetterProc(API_TranslatorNameConfig &translator) |
| |
| typedef GSErrCode | InfoGetterProc(const API_UserData *const userData, GS::UniString &info, bool general) |
| |
|
| enum | API_SaveMethod {
Save2DProc = 0
, SaveSectionProc = 1
, Save3DProc = 2
, SaveRenderingProc = 3
,
SaveTextProc = 4
, SaveReportProc = 5
, SaveDrawProc = 6
, SaveLayoutProc = 7
,
SaveMovie3DProc = 8
, SaveMovieRenderingProc = 9
, SaveDetailDrawingProc = 10
, SaveIESProc = 11
,
SaveDocumentFrom3DProc = 12
} |
| | Defines the different save methods in Archicad. More...
|
| |
Functions for integrating into the publisher or registering new supported file types.
◆ DefaultTranslatorGetterProc
Callback function to receive the default translator for the new registered publish format.
- Parameters
-
| translator | [out] The output parameter of this function. This configuration will be set to hold the default translator of the format. |
- Returns
- NoError - The function has been completed with success.
◆ InfoGetterProc
| typedef GSErrCode InfoGetterProc(const API_UserData *const userData, GS::UniString &info, bool general) |
Callback function to receive a string providing additional information about a publisher format or its current configuration.
- Parameters
-
| info | [out] The info string that can be displayed by the Publisher. |
| general | [in] Indicates that the info string should have contents for a Publisher Folder item that has the same format items, but with different info |
- Returns
- NoError - The function has completed with success.
◆ SaveInitialOptionProc
Callback function to set initial options for the newly registered format.
- Parameters
-
| method | [in] Any of Save2DProc, SaveSectionProc, Save3DProc, SaveRenderingProc, SaveTextProc, SaveReportProc, SaveDrawProc, SaveLayoutProc, SaveMovie3DProc, SaveMovieRenderingProc, SaveDetailDrawingProc, SaveIESProc, SaveDocumentFrom3DProc |
| userData | [in] The userData contains the save options given by the Add-On. |
- Returns
- NoError - The function has been completed with success.
◆ SaveOptionProc
Callback function to set different options for the newly registered format.
- Parameters
-
| method | [in] Any of Save2DProc, SaveSectionProc, Save3DProc, SaveRenderingProc, SaveTextProc, SaveReportProc, SaveDrawProc, SaveLayoutProc, SaveMovie3DProc, SaveMovieRenderingProc, SaveDetailDrawingProc, SaveIESProc, SaveDocumentFrom3DProc |
| userData | [in] The userData contains the save options given by the Add-On. |
- Returns
- NoError - The function has been completed with success.
◆ SaveTranslatorProc
Callback function to set the translator configuration for the newly registered format.
- Parameters
-
| method | [in] Any of Save2DProc, SaveSectionProc, Save3DProc, SaveRenderingProc, SaveTextProc, SaveReportProc, SaveDrawProc, SaveLayoutProc, SaveMovie3DProc, SaveMovieRenderingProc, SaveDetailDrawingProc, SaveIESProc, SaveDocumentFrom3DProc |
| translator | [in] The translator configuration given by the Add-On. |
- Returns
- NoError - The function has been completed with success.
◆ SaveWithOptionProc
Callback function to save the document with set options in the newly registered publish format.
- Parameters
-
| method | [in] Any of Save2DProc, SaveSectionProc, Save3DProc, SaveRenderingProc, SaveTextProc, SaveReportProc, SaveDrawProc, SaveLayoutProc, SaveMovie3DProc, SaveMovieRenderingProc, SaveDetailDrawingProc, SaveIESProc, SaveDocumentFrom3DProc |
| path | [in] The path where to save the published file. |
| userData | [in] The userData contains the save options given by the Add-On. |
| reportStr | [in] The error message if the publishing failed. |
- Returns
- NoError - The function has been completed with success.
◆ SaveWithTranslatorProc
Callback function to save the document with a translator in the newly registered publish format.
- Parameters
-
| method | [in] Any of Save2DProc, SaveSectionProc, Save3DProc, SaveRenderingProc, SaveTextProc, SaveReportProc, SaveDrawProc, SaveLayoutProc, SaveMovie3DProc, SaveMovieRenderingProc, SaveDetailDrawingProc, SaveIESProc, SaveDocumentFrom3DProc |
| path | [in] The path where to save the published file. |
| translator | [in] The translator configuration given by the Add-On. |
| reportStr | [in] The error message if the publishing failed. |
- Returns
- NoError - The function has been completed with success.
◆ TranslatorGetterProc
Callback function to receive the translators for the new registered publish forma.
- Parameters
-
| arr | [out] The array which will be filled with translator configurations. |
- Returns
- NoError - The function has been completed with success.
◆ API_SaveMethod
Defines the different save methods in Archicad.
| Enumerator |
|---|
| Save2DProc | Save2DProc
|
| SaveSectionProc | SaveSectionProc
|
| Save3DProc | Save3DProc
|
| SaveRenderingProc | SaveRenderingProc
|
| SaveTextProc | SaveTextProc
|
| SaveReportProc | SaveReportProc
|
| SaveDrawProc | SaveDrawProc
|
| SaveLayoutProc | SaveLayoutProc
|
| SaveMovie3DProc | SaveMovie3DProc
|
| SaveMovieRenderingProc | SaveMovieRenderingProc
|
| SaveDetailDrawingProc | SaveDetailDrawingProc
|
| SaveIESProc | SaveIESProc
|
| SaveDocumentFrom3DProc | SaveDocumentFrom3DProc
|
