ISelectableDialogSwitcher.h

//========================================================================================
// 
// $File$
// 
// Owner: 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 __ISelectableDialogSwitcher__
#define __ISelectableDialogSwitcher__

#include "IPMUnknown.h"
#include "IControlView.h"

class IControlView;
class IPanelControlData;
class PMString;
class IListControlData;
class IDialog;
class IPanelCreator;

// Constants used by auto-resizing selectable dialogs.
const int32 kMinGroupBoxHeight = 130; // Minimum height of groupbox.
const int32 kGroupBorderOffset = 15; // Y offset between bottom of dialog panel and group border widget in main panel.
const int32 kWindowGroupOffset = 12; // Y offset between bottom of group border widget and the window.

class ISelectableDialogSwitcher : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISELECTABLEDIALOGSWITCHER };
 
 enum {kNextPanel = -1, kPreviousPanel = -2};

 virtual void SwitchDialogPanel(int32 dialogNumber, bool16 validate = kTrue) = 0;
 
 virtual void SwitchDialogPanelByID(WidgetID panelsWidgetID) = 0;
 
 virtual void AddDialogPanel(IControlView* dialogPanel, const PMString& panelName, int32 at = -1, bool16 autoVisible = kTrue) = 0;
 
 virtual IControlView* GetDialogPanel(WidgetID panelsWidgetID) = 0;
 
 virtual void SetDialogServiceID(const ServiceID& dialogServiceID,
 const WidgetID dialogGroupPanelWidgetID = kDialogGroupPanelWidgetID,
 const WidgetID dialogSelectionWidgetID = kSelectDialogSelectionWidgetID,
 const WidgetID dialogTitleTextWidgetID = kSelectDialogTitleTextWidgetID) = 0;
 
 virtual ServiceID GetDialogServiceID() const = 0;
 
 virtual WidgetID GetGroupPanelWidgetID() const = 0;
 
 virtual WidgetID GetSelectionListWidgetID() const = 0;
 
 virtual WidgetID GetTitleTextWidgetID() const = 0;
 

 virtual IPanelControlData* QueryGroupPanelControlData() = 0;
 
 virtual void LoadDialogPanels() = 0;
 
 virtual void ShowDialogPanel(const WidgetID panelWidgetID, const bool16 show = kTrue) = 0;
 

 virtual void HideNonAutoShownPanels() = 0;
 
 virtual int32 GetCurrentPanelIndex() const = 0;
 
 virtual WidgetID GetPanelWidgetID(int32 index) const = 0;

 virtual bool16 GetAutoResizable() const = 0;

 virtual void SetAutoResizable(const bool16 bAutoSize) = 0;
 

 virtual void RemoveDialogPanel(IControlView* dialogPanel) = 0;

 virtual int32 GetDialogPanelIndex(WidgetID panelWidgetID) const = 0;
 
 virtual int32 GetNumDialogPanels() const = 0;
 
 virtual void UnloadDialogPanels() = 0;

 /* gives the keyboard focus to the selected list */
 virtual bool16 SetKeyFocusToSelectionList() = 0;
};

#endif