IDialog.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 __IDialog__
#define __IDialog__

#include "IPMUnknown.h"
#include "IControlView.h"
#include "ICursorMgr.h"
#include "widgetid.h"

class IDialog : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDIALOG };

 enum DialogType
 { 
 kModal = 0, 
 kMovableModal,
 kModeless
 };
 
 virtual void SetDialogType(DialogType dialogType) = 0;
 
 virtual DialogType GetDialogType() const = 0;

 virtual void Open(IControlView* ownerPanel = nil, bool16 doWait = kTrue) = 0;

 virtual void OpenWithModalCursorType(int16 modalCursorType, IControlView* ownerPanel = nil) = 0;

 virtual void Close() = 0;

 virtual void WaitForDialog(bool16 bSupressScheduled = kFalse) = 0;

 virtual bool16 GetBufferCommands() const = 0;

 virtual void SetBufferCommands(bool16 bufferCommands) = 0;

 enum DialogPosition { kNoPosition = 0, kAutoCenter, kCenterNearTop, kRememberPosition };
 
 virtual void SetDialogPositioningAlgorithm(DialogPosition dialogPosition) = 0;

 virtual DialogPosition GetDialogPositioningAlgorithm() const = 0;

 enum DialogFocus { kNoAutoFocus = 0, kFirstTextBox };

 
 virtual void SetDialogFocusingAlgorithm(DialogFocus dialogFocus) = 0;
 
 virtual DialogFocus GetDialogFocusAlgorithm() const = 0;

 virtual bool16 IsOpen() const = 0;
 
 virtual bool16 HasPreviewButton() const = 0;
 
 virtual IControlView* GetDialogPanel() const = 0;

 virtual WidgetID SetDefaultButton(const WidgetID buttonID) = 0;

 virtual WidgetID GetDefaultButton() const = 0;
 
 
 virtual void PressDefaultButton() = 0 ;

 virtual void CleanUpBeforeClose() = 0;

 virtual void CleanUpAfterClose() = 0;

 virtual void SetDialogPanelID(const WidgetID panelID) = 0;
 
 virtual void DialogCancelled() = 0;


 virtual void SetDeleteOnClose(bool16 deleteOnClose) = 0;

 virtual bool16 GetDeleteOnClose() const = 0;

 /* Internal Use */
 virtual void PostDelayedWaitForDialog() const = 0;

 virtual void AddResizingGripperIcon() = 0;
};

#endif