IDialogMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IDialogMgr_h__
#define __IDialogMgr_h__

#include "IPMUnknown.h"
#include "IDialog.h"
#include "ShuksanID.h"

class IResourceAccess;
class RsrcSpec;
class IWindow;

class IDialogMgr : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDIALOGMGR };
 
 enum
 {
 kAllowMultipleCopies = kTrue,
 kDontAllowMultipleCopies = kFalse,
 
 kCacheDialog = kTrue,
 kDontCacheDialog = kFalse,
 
 kAllowUserResize = kTrue,
 kDontAllowUserResize = kFalse,
 };

 virtual IDialog* CreateNewDialog(const RsrcSpec& spec,
 const IDialog::DialogType& dialogType,
 bool16 allowMultipleCopies = kAllowMultipleCopies, 
 bool16 okToCacheDialog = kCacheDialog,
 bool16 allowResize = kDontAllowUserResize) = 0;

 virtual IDialog* CreateNewDialog(ClassID windowClass, const RsrcSpec& spec,
 const IDialog::DialogType& dialogType,
 bool16 allowMultipleCopies = kAllowMultipleCopies, 
 bool16 okToCacheDialog = kCacheDialog,
 bool16 allowResize = kDontAllowUserResize) = 0;
 
 virtual bool16 IsModalDialogOpen() const = 0;

 virtual bool16 IsModelessDialogInFront() const = 0;
 
 virtual bool16 IsAnyDialogInFront() const = 0;

 virtual IWindow* GetFrontmostDialogWindow() const = 0;

 // ----- Internal Use -----
 virtual void IncrementModalDialogCnt() = 0;
 virtual void DecrementModalDialogCnt() = 0;
 virtual uint16 GetModalDialogCnt() const = 0;

 virtual void SetSuppressDialogs( bool16 suppress ) = 0 ;

 virtual bool16 GetSuppressDialogs() const = 0 ;
 
#ifdef WINDOWS
 // Following set of APIs should be used by users to mark the opening and closing of clients own platform defined dialog.
 // While opening the dialog, clients should call PlatformWindowOpening and while closing the dialog PlatformWindowClosed.
 virtual void PlatformWindowOpening() = 0;
 virtual void PlatformWindowClosed() = 0;
 virtual bool16 IsPlatformWindowOpen() = 0;

 // Following APIs are used internally in Indesign to save the current focus control in the platform windows control.
 // And restore focus to the saved control
 // Clients should use this functions only if they want to save and restore the focus.
 virtual bool16 HasSavedFocusedPlatformWindow() = 0;
 virtual void SaveFocusedPlatformWindow() = 0;
 virtual void RestoreFocusToPlatformWindow() = 0;
#endif

 /* Internal Use */
 virtual uint64 ClearDialogInstanceList(bool16 reportMemoryUsed=kFalse) = 0;
 virtual bool16 CanProcessDelayedWaitForDialog(IDialog *iDialog) = 0;
 virtual void ClearDialogFromInstanceList(IDialog* iDialog) = 0;
#ifdef WINDOWS
 virtual void SaveFocusedExternalWindow() = 0;
 virtual void RestoreFocusToExternalWindow() = 0;
#endif

#ifdef MACINTOSH
 /* ----- Internal Use -----
 It is used to stop the modal loop triggerd by modal dialog 
 */
 virtual void StopModal() = 0;
#endif
};

#endif