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

#include <IShowAlertRegistryUtils.h>

Inheritance diagram for IShowAlertRegistryUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISHOWALERTREGISTRYUTILS }
 

Public Member Functions

virtual bool32 GetShouldShow (int32 alertID)=0
 
virtual ErrorCode DoSetShouldShowCmd (int32 alertID, bool32 shouldShow)=0
 
virtual ErrorCode DoClearAllCmd ()=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

Utilities for querying and modifying 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.

See Also
IShowAlertRegistry

Member Function Documentation

virtual ErrorCode IShowAlertRegistryUtils::DoClearAllCmd ()
pure virtual

Processes a command to set the should-show state to show/enable for all alerts.

Returns
The command error code.
virtual ErrorCode IShowAlertRegistryUtils::DoSetShouldShowCmd (int32 alertID,
bool32 shouldShow 
)
pure virtual

Processes a command to set the should-show state for the specified alert.

Parameters
alertIDThe alert to show/not-show.
shouldShowkTrue to show (enable) the alert; kFalse to not-show (disable) the alert.
Returns
The command error code.
virtual bool32 IShowAlertRegistryUtils::GetShouldShow (int32 alertID)
pure virtual

Returns whether the specified alertID should be shown.

Parameters
alertIDThe alert ID you're interested in.
Returns
kTrue to show the alert; kFalse not to.