InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IAMUIServiceProvider Class Referenceabstract

#include <IAMUIServiceProvider.h>

Inheritance diagram for IAMUIServiceProvider:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IAMUISERVICEPROVIDER }
 
enum  UIService {
  enInvalidService = 0, enSaveAsDialog = kWorkgroupPrefix + 1, enViewVersions = kWorkgroupPrefix + 2, enSaveAlert = kWorkgroupPrefix + 3,
  enRevertAlert = kWorkgroupPrefix + 4, enSaveACopyDialog = kWorkgroupPrefix + 5, enSaveMultiLinkAlert = kWorkgroupPrefix + 6, enGetVersionComments = kWorkgroupPrefix + 7,
  enGetBatchVersionComments = kWorkgroupPrefix + 8, enConflictAlert = kWorkgroupPrefix + 9, enLiveEditConflictAlert = kWorkgroupPrefix + 10
}
 

Public Member Functions

virtual void Enable (bool16 b)=0
 
virtual bool16 IsEnabled (void)=0
 
virtual IAMUIService * GetService (int32 uiServiceID)=0
 
virtual bool16 IsServiceAvailable (UIDRef assetRef, int32 uiServiceID)=0
 
virtual void ShowAllWarningDialogs ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The IAMUIServiceProvider interface is responsible for providing IAMUIServices.

See Also
IAMUIService.

Member Enumeration Documentation

enum IAMUIServiceProvider::UIService

The UIService enum defines the ID numbers for all of the asset management UI services currently used by the InDesign/InCopy/InDesignServer codebase. This list may be extended as needed by defining new unique ID numbers.
Enumerator
enInvalidService 

This is the default UIService ID.

enSaveAsDialog 

This service displays a SaveAs dialog. 

    Input IAMServiceData parameters:



        IAMUIService::enDefaultFile (IDFile)

        IAMUIService::enUseSystemDefaultDirectory (boolean flag)



    Output IAMServiceData parameters:



        IAMUIService::enSelectedFile (IDFile)

        IAMUIService::enSaveAsStationery (boolean flag)

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enSave (save to the IAMUIService::enSelectedFile).

            IAMUIService::enCancel (cancel all followup processing).
enViewVersions 

This service displays a dialog to view historical versions. 

    Input IAMServiceData parameters: none.

    Output IAMServiceData parameters:



        IAMUIService::enTemporaryVersionFile (IDFile)

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enPromoteVersion

            IAMUIService::enOpenFile (open the IAMUIService::enTemporaryVersionFile)        

            IAMUIService::enNone (no followup action or data).
enSaveAlert 

This service displays a save alert dialog. 

    Input IAMServiceData parameters:

        IAMUIService::enDocumentName (PMString)



    Output IAMServiceData parameters:

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enSave (save the document)

            IAMUIService::enCancel (cancel the current operation)

            IAMUIService::enSaveVersion (save a version)

            IAMUIService::enDontSave (discard unsaved changes)
enRevertAlert 

This service displays a revert alert dialog. 

    Input IAMServiceData parameters: none.

    Output IAMServiceData parameters:

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enRevertToLastVersion

            IAMUIService::enRevertDocument

            IAMUIService::enCancel
enSaveACopyDialog 

This service displays a dialog to save a copy of a document. 

    Input IAMServiceData parameters:

        IAMUIService::enUseSystemDefaultDirectory (boolean flag)



    Output IAMServiceData parameters:

        IAMUIService::enSelectedFile (IDFile)

        IAMUIService::enSaveAsStationery (boolean flag)

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enSave

            IAMUIService::enCancel
enSaveMultiLinkAlert 

This service displays an alert when saving multiple links. 

    Input IAMServiceData parameters: none.

    Output IAMServiceData parameters:

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enCancel

            IAMUIService::enDefaultAction
enGetVersionComments 

This service displays a dialog to get version comments for checkin. 

    Input IAMServiceData parameters: none.

    Output IAMServiceData parameters:

        IAMUIService::enVersionComment (PMString)

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enDefaultAction (comment string available as IAMUIService::enVersionComment)

            IAMUIService::enCancel (cancel all followup processing)
enGetBatchVersionComments 

This service displays a dialog to get version comments for a batch checkin. 

    Input IAMServiceData parameters:

        IAMUIService::enAssetCount (int32)



    Output IAMServiceData parameters:

        IAMUIService::enVersionComment (PMString)

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enDefaultAction (comment string available as IAMUIService::enVersionComment)

            IAMUIService::enCancel (cancel all followup processing)

            IAMUIService::enNone
enConflictAlert 

This service displays a version or lock conflict alert. 

    Input IAMServiceData parameters: none.



    Output IAMServiceData parameters:

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enOverrideAndSaveAVersion         

            IAMUIService::enRevertToLastVersion
enLiveEditConflictAlert 

This service displays the LiveEdit conflict alert which offers the option to embed story content. 

    Input IAMServiceData parameters:

        IAMUIService::enCheckedOutBy (PMString; stories only)

        IAMUIService::enCheckedOutApp (PMString; stories only)

        IAMUIService::enCheckedOutDoc (PMString; stories only)

        IAMUIService::enMessageText (PMString; stories only)            



    Output IAMServiceData parameters:

        IAMUIService::enFollowupAction (IAMUIService::FollowupAction):



            IAMUIService::enDefaultAction       

            IAMUIService::enCancel

Member Function Documentation

virtual void IAMUIServiceProvider::Enable (bool16 b)
pure virtual

This method enables or disables the UI service provider. When disabled, the GetService() method returns nil for every UI service ID.

Parameters
bif kTrue enable UI; else disable UI.
virtual IAMUIService* IAMUIServiceProvider::GetService (int32 uiServiceID)
pure virtual

The GetService method obtains an instance of an IAMUIService interface for a specified UIService ID. The IAMUIService pointer is returned with a refcount of 1; the caller of this method is responsible for releasing the IAMUIService pointer. Suggested usage: 

InterfacePtr<IAMUIService> pService( myAMUIServiceProvider->GetService( myServiceID ) );

The advantage of the suggested usage is that the IAMUIService pointer will be released automatically when pService goes out of scope.

virtual bool16 IAMUIServiceProvider::IsEnabled (void )
pure virtual

This method tests if UI service provider is enabled.

Returns
kTrue if enabled; kFalse otherwise.
virtual bool16 IAMUIServiceProvider::IsServiceAvailable (UIDRef assetRef,
int32 uiServiceID 
)
pure virtual

Tests if an IAMUIService is available.

Parameters
assetRefis the UIDRef of an IManageableAsset.
uiServiceIDis a unique UIService identifier.
Returns
kTrue if the service is available; kFalse otherwise.
virtual void IAMUIServiceProvider::ShowAllWarningDialogs ()
pure virtual

This method controls displaying warning dialogs by the underlying asset management system.