CDialogController.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 __CDialogController__
#define __CDialogController__

#include "IDialogController.h"
#include "CPMUnknown.h"

#ifdef WIDGET_BUILD
#endif

class CDialogController : public CPMUnknown<IDialogController>
{
public:
 // ----- Initialization -----
 
 CDialogController(IPMUnknown *boss);
 virtual ~CDialogController();
 
 // ----- Dialog protocol -----
private:
 friend class QAFontDlgController; //SEIssue fix this
 
 // Framework Only - Don't call or override these, they call the protected XXXFields methods below.
 virtual WidgetID ValidateDialog();
 virtual void ApplyDialog( const WidgetID& widgetId);
 virtual void ResetDialog();
 virtual void DialogClosing();
 virtual void InitializeDialog(IActiveContext* context);

 // Deprecated: These are declared here just to cause compiler errors in existing code.
 virtual int ApplyFields(const WidgetID& /*widgetId*/) const {ASSERT_FAIL("Implement ApplyDialogFields instead"); return 0;}
 virtual char* ValidateFields() const {ASSERT_FAIL("Implement ValidateDialogFields instead"); return 0;}
 virtual int ResetFields() const {ASSERT_FAIL("Implement ResetDialogFields instead"); return 0;}
 virtual int InitializeFields() const {ASSERT_FAIL("Implement InitializeDialogFields instead"); return 0;}
 
protected:
 virtual void InitializeDialogFields(IActiveContext* context);
 
 virtual WidgetID ValidateDialogFields(IActiveContext* myContext);

 virtual void ApplyDialogFields(IActiveContext* myContext, const WidgetID& widgetId);
 
 virtual void ResetDialogFields(IActiveContext* myContext);

public:
 virtual void UserCancelled();

 virtual void ClosingDialog(IActiveContext* lastChanceToUseMyContext);

 // ----- Dialog query methods -----

 virtual bool16 HasBeenInitialized() const;

 virtual void SetInitialized(bool16 initialized);

 // ----- Owner query methods -----

 virtual void SetOwner(IControlView* ownerPanel);

 virtual IControlView* GetOwner() const;

 // ----- Previewable dialog methods -----

 virtual void GetName(PMString& name);


 virtual void SetTextControlData(const WidgetID& widgetId, const PMString& text, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);
 virtual PMString GetTextControlData(const WidgetID& widgetId, const IPanelControlData* panel = nil) const;
 
 virtual void SetTextValue(const WidgetID& widgetId, const PMReal& value, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);
 virtual PMReal GetTextValue(const WidgetID& widgetId, const IPanelControlData* panel = nil, bool16 *outParsingError = nil,bool16 *outIsBlank = nil) const;
 virtual void SetTextValueControlState(const WidgetID& widgetId, ITextValue::TextControlState controlState, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);
 virtual ITextValue::TextControlState GetTextValueControlState(const WidgetID& widgetId, const IPanelControlData* panel = nil) const;
 // Helper methods for easily setting and getting the value from a
 // widget(editbox) that has an ITextValue interface
 
 virtual void SetBooleanControlData(const WidgetID& widgetId, bool16 isChecked, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);
 virtual bool16 GetBooleanControlData(const WidgetID& widgetId, const IPanelControlData* panel = nil) const;

 virtual void SetTriStateControlData(const WidgetID& widgetId, bool16 isSelected, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);
 virtual void SetTriStateControlData(const WidgetID& widgetId, ITriStateControlData::TriState triState, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);
 virtual ITriStateControlData::TriState GetTriStateControlData(const WidgetID& widgetId, const IPanelControlData* panel = nil) const;
 
 virtual WidgetID GetSelectedClusterWidget(WidgetID cluster, const IPanelControlData* panel = nil);
 virtual void SetSelectedClusterWidget(WidgetID clusterId, WidgetID widgetToSelect, const IPanelControlData* panel = nil, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue);

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

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

 virtual void SelectDialogWidget(const WidgetID& widgetId);

 virtual bool16 GetPreviewModeOn();
 virtual void SetPreviewModeOn(bool16 bOn);

 virtual IActiveContext* QueryDialogContext();

private:
 bool16 fInitialized;
 IControlView* fOwner;
 PMString fName;
 bool16 fPreviewModeOn;
 IActiveContext* fDialogContext;
};


#endif