IDialogController.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard (was Tom Taylor)
// 
// $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 __IDialogController__
#define __IDialogController__

#include "IPMUnknown.h"
#include "IControlView.h"
#include "ITriStateControlData.h"
#include "ITextValue.h"
#include "PMString.h"

class IStringListControlData;
class IControlView;
class IPanelControlData;
class IDialog;
class IActiveContext;

static const WidgetID kNoInvalidWidgets = 0;

class IDialogController : public IPMUnknown
{
#if 0
 friend class CSelectableDialogController;
 friend class CDialogObserver;
 friend class CDialog;
 friend class CSelectableDialogSwitcher;
#endif

public:
 enum { kDefaultIID = IID_IDIALOGCONTROLLER };
 // ---------------------------

 virtual void InitializeDialog(IActiveContext* context) = 0;
 virtual IActiveContext* QueryDialogContext() = 0;

 virtual WidgetID ValidateDialog() = 0;


 virtual void ApplyDialog(const WidgetID& widgetId) = 0;


 virtual void ResetDialog() = 0;


 virtual void UserCancelled() = 0;

 virtual void DialogClosing() = 0;



 // --------------------------------

 virtual bool16 HasBeenInitialized() const = 0;
 //

 virtual void SetInitialized(bool16 initialized) = 0;



 // --------------------------------

 virtual void SetOwner(IControlView* ownerPanel) = 0;


 virtual IControlView* GetOwner() const = 0;
 //


 // --------------------------------

 virtual void GetName(PMString& name) = 0;


 // --------------------------------

 virtual void SetTextControlData(const WidgetID& widgetId, const PMString& text, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual PMString GetTextControlData(const WidgetID& widgetId, const IPanelControlData* panel = nil) const = 0;


 virtual void SetTextValue(const WidgetID& widgetId, const PMReal& value, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual PMReal GetTextValue(const WidgetID& widgetId, const IPanelControlData* panel = nil, bool16 *outParsingError = nil,bool16 *outIsBlank = nil) const = 0;

 virtual void SetTextValueControlState(const WidgetID& widgetId, ITextValue::TextControlState controlState, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual ITextValue::TextControlState GetTextValueControlState(const WidgetID& widgetId, const IPanelControlData* panel = nil) const = 0;


 virtual void SetBooleanControlData(const WidgetID& widgetId, bool16 isChecked, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual bool16 GetBooleanControlData(const WidgetID& widgetId, const IPanelControlData* panel = nil) const = 0;


 virtual void SetTriStateControlData(const WidgetID& widgetId, ITriStateControlData::TriState triState, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual void SetTriStateControlData(const WidgetID& widgetId, bool16 isSelected, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual ITriStateControlData::TriState GetTriStateControlData(const WidgetID& widgetId, const IPanelControlData* panel = nil) const = 0;


 virtual WidgetID GetSelectedClusterWidget(WidgetID cluster, const IPanelControlData* panel = nil) = 0;

 virtual void SetSelectedClusterWidget(WidgetID clusterId, WidgetID widgetToSelect, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;


 virtual IStringListControlData* QueryListControlDataInterface(const WidgetID& widgetId, const IPanelControlData* panel = nil) const = 0;


 virtual IPanelControlData* QueryIfNilElseAddRef(const IPanelControlData* panel) const = 0;

 virtual void SelectDialogWidget(const WidgetID& widgetId) = 0;

 virtual bool16 GetPreviewModeOn() = 0;

 virtual void SetPreviewModeOn(bool16 bOn) = 0;

};

#endif