InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISetShowAlertRegistryCmdData Class Referenceabstract

#include <ISetShowAlertRegistryCmdData.h>

Inheritance diagram for ISetShowAlertRegistryCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISETSHOWALERTREGISTRYCMDDATA }
 

Public Member Functions

virtual void SetAlertID (int32 alertID)=0
 
virtual int32 GetAlertID () const =0
 
virtual void SetShouldShow (int32 shouldShow)=0
 
virtual int32 GetShouldShow () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface provides the data for the SetShowAlertRegistry command.

See Also
IShowAlertRegistry
IShowAlertRegistryUtils

Member Function Documentation

virtual int32 ISetShowAlertRegistryCmdData::GetAlertID () const
pure virtual

Gets the alert ID to show/not-show.

Returns
The ID of the alert.
virtual int32 ISetShowAlertRegistryCmdData::GetShouldShow () const
pure virtual

Indicates the show/not-show state for the command.

Returns
kTrue if the alert will be enabled, kFalse if disabled.
virtual void ISetShowAlertRegistryCmdData::SetAlertID (int32 alertID)
pure virtual

Sets the alert ID to show/not-show. Passing -1 will clear all alerts.

Parameters
alertIDThe ID of the alert, or -1 to clear all alerts.
virtual void ISetShowAlertRegistryCmdData::SetShouldShow (int32 shouldShow)
pure virtual

Sets whether to show or not-show the specified alert the next time it is activated. If the specified alert ID is -1, this parameter is ignored (assumes kTrue).

Parameters
shouldShowkTrue to show the alert next time. kFalse to disable the alert.