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

#include <IShowAlertRegistry.h>

Inheritance diagram for IShowAlertRegistry:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISHOWALERTREGISTRY }
 

Public Member Functions

virtual void Clear ()=0
 
virtual bool32 GetShouldShow (int32 alertID) const =0
 
virtual void SetShouldShow (int32 alertID, bool32 shouldShow)=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 implements the "don't-show" registry, which controls which alerts are shown and which are not, based on the user's previous checking of "don't show this alert again" checkbox in many alerts, as well as the "show all alerts again" option in preferences, which brings them all back to life.

The interface lives on the application workspace.

See Also
IShowAlertRegistryUtils

Member Function Documentation

virtual void IShowAlertRegistry::Clear ()
pure virtual

Set all alerts to show.

virtual bool32 IShowAlertRegistry::GetShouldShow (int32 alertID) const
pure virtual

Get whether to show a specific alert.

Parameters
alertIDThe ID you're interested in.
Returns
kTrue if the alert is enabled; kFalse if not.
virtual void IShowAlertRegistry::SetShouldShow (int32 alertID,
bool32 shouldShow 
)
pure virtual

Set a specific alert to show or not-show.

Parameters
alertIDThe ID you're interested in.
shouldShowkTrue to enable the alert; kFalse to disable it.