InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AcquireModalDialogAndCursorState Class Reference

#include <AcquireModalDialogAndCursorState.h>

Public Member Functions

 AcquireModalDialogAndCursorState (bool isDVAOwnedWindow=false)
 
 AcquireModalDialogAndCursorState (int16 modalCursorType, bool isDVAOwnedWindow=false)
 
virtual ~AcquireModalDialogAndCursorState ()
 

Static Public Member Functions

static bool IsExternalModalDialogRunning ()
 

Detailed Description

Helper object class used to acquire, manipulate, and release an external modal dialog.

This helper can be either stack or heap allocated depending on how far flung the two ends of the modality are. If it all happens within the body of a single function or single function call chain, then stack based is preferred. If the start and end are in separate functions, then heap based should be used.

Constructor & Destructor Documentation

AcquireModalDialogAndCursorState::AcquireModalDialogAndCursorState (bool isDVAOwnedWindow = false)

Constructs the object and deactivates palettes, acquires a modal dialog cursor state, and grabs the cursor focus.

Parameters
isDVAOwnedWindow,:specifies if we setting modal windows state for DVA owned window, do not need push modal NULL modal window
AcquireModalDialogAndCursorState::AcquireModalDialogAndCursorState (int16 modalCursorType,
bool isDVAOwnedWindow = false 
)

Constructs the object and deactivates palettes, acquires a cursor state in the specified mode, and grabs the cursor focus.

Parameters
isDVAOwnedWindow,:specifies if we setting modal windows state for DVA owned window, do not need push modal NULL modal window
modalCursorTypeIN Cursor state mode to acquire
virtual AcquireModalDialogAndCursorState::~AcquireModalDialogAndCursorState ()
virtual

Destructs the object and reactivates palettes, releases the modal cursor state, and restores the cursor focus.

Member Function Documentation

static bool AcquireModalDialogAndCursorState::IsExternalModalDialogRunning ()
inlinestatic

Signals that an external modal dialog is currently active.