IWindow.h

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

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

#include "PMReal.h"
#include "PMRect.h"
#include "WindowVisibleState.h"

class ICursorMgr;
class PMString;
class IEvent;
class IViewPort;
class InterfaceFontInfo;

// window property constants to get the data we want on the mac.
const uint32 kIWindowPtrProp = 'IWin'; // data is the IWindow*

class INTERFACE_DECL IWindow : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IWINDOW };

 enum VisibleState { kHide = SW_HIDE, kMaximize = SW_MAXIMIZE, kMinimize = SW_MINIMIZE,
 kRestore = SW_RESTORE, kShow = SW_SHOW, kShowNormal = SW_SHOWNORMAL,
 kShowNoActivate = SW_SHOWNA };
 
 enum WindowSpec{ 
 /* The lowest 4 bits are for Window layer property. Each window must have exactly one window layer specified. This determines which windows float above
 which others. This property must be set. The following layer constants are sequenced in front to back order so that layers with a higher enum value overlap those with a lower enum value. 
 Note there are some holes for possible additional window layers in the future. The window layer for a window will determine the default window frame, controls, and other policies for the window
 kWindowLayerMask is the mask to use to get the window layer bits out of the window spec bitfield. 
 */
 kWindowLayerMask = (0x0000000FUL),
 
 kAppRootWindowLayer = 1, 
 kDocumentWindowLayer = 2, 
 kToolbarWindowLayer = 4, 
 kPaletteWindowLayer = 5, 
 kAppModalWindowLayer = 7, 
 kUtilityWindowLayer = 11, 
 kMenuWindowLayer = 13,
 kHelpWindowLayer = 14, 


 kWindowFrameMask = (0x000000F0UL),
 kStandardWindowFrame = 0, 
 kDocWindowFrame = (1UL << 4), 
 kPaletteWindowFrame = (2UL << 4), 
 kModelessDialogWindowFrame = (3UL << 4),
 kMovableModalDialogWindowFrame = (4UL << 4), 
 kModalDialogWindowFrame = (5UL << 4),
 kMovableAlertWindowFrame = (6UL << 4),
 kAlertWindowFrame = (7UL << 4),
 kAppRootWindowFrame = (8UL << 4),
 kBorderOnlyWindowFrame = (9UL << 4), 
 kCustomWindowFrame = (14UL << 4), 
 kNoWindowFrame = (15UL << 4), 

 kWindowControlsMask = (0x0000FF00),
 kStandardWindowControls = 0, 
 kCloseWindowControl = (1UL << 8),
 kZoomWindowControl = (1UL << 9),
 kCollapseWindowControl = (1UL << 10),
 kResizeWindowControl = (1UL << 11),
 kToolbarWindowControl = (1UL << 12),
 kSideTitlebarControl = (1UL << 13), 
 kRemoveTitlebarControl = (1UL << 14), 
 kListAbsentWindowControls = (1UL << 15), 
 kNoWindowControls = kWindowControlsMask,
 kAllWindowControls = kListAbsentWindowControls,
 kStandardDocWindowControls = (kCloseWindowControl | kZoomWindowControl | kCollapseWindowControl | kResizeWindowControl),
 kStandardPaletteWindowControls = (kCloseWindowControl | kZoomWindowControl),

 kWindowPolicyMask = (0xFFFF0000UL),
 kStandardWindowPolicy = 0, 
 
 kHideInBackgroundWindowPolicy = (1UL << 16), 
 kDontHideInBackgroundWindowPolicy = (1UL << 17), 
 
 kTabCyclesKeyFocusWindowPolicy = (1UL << 18),
 kTabDoesntCycleKeyFocusWindowPolicy = (1UL << 19),
 
 kRememberLastEditboxKeyFocusWindowPolicy = (1UL << 20),
 kDontRememberLastEditboxKeyFocusWindowPolicy = (1UL << 21),
 
 kHasDefaultButtonWindowPolicy = (1UL << 22),
 kDoesntHaveDefaultButtonWindowPolicy = (1UL << 23),
 
 kMovableWindowPolicy = (1UL << 24), 
 kNonMovableWindowPolicy = (1UL << 25),
 
 kListBoxGrabsKeyFocusWindowPolicy = (1UL << 26), 
 kListBoxDoesntGrabsKeyFocusWindowPolicy = (1UL << 27),
 
 kDoUnused1WindowPolicy = (1UL << 28),
 kDontUnused1WindowPolicy = (1UL << 29),
 
 kDoUnused2WindowPolicy = (1UL << 30),
 kDontUnused2WindowPolicy = (1UL << 31)
 };


public:
 virtual void InitWindow( uint32 policyBits) = 0;

 virtual void OpenWindow() = 0;

 virtual void CloseWindow() = 0;
 
 virtual void PlatformWindowClosed() = 0;

 virtual void SetTitle(const PMString& newtitle) = 0; 

 virtual const PMString& GetTitle() const = 0;
 
 virtual const InterfaceFontInfo& GetFont() const = 0;
 
 virtual const InterfaceFontInfo& GetHiliteFont() const = 0;

 virtual void SetFrameBBox(const GSysRect& rt) = 0;
 
 virtual GSysRect GetFrameBBox() const = 0;
 
 virtual GSysRect GetContentBBox() const = 0;
 
 virtual void SetContentBBox(const GSysRect& bbox) = 0;
 
 virtual int32 GetTitlebarHeight() const = 0;
 
 virtual int32 GetBorderWidth() const = 0;
 
 virtual SysRect GetVisRgnBBox() const = 0;

 virtual void Resize(SysCoord newWidth, SysCoord newHeight) = 0; 
 
 virtual void SetPosition(GSysCoord xPos, GSysCoord yPos, bool16 inFront) = 0;
 
 virtual void CenterOnScreen() = 0;
 
 virtual SysWindow GetSysWindow() const = 0;

#ifdef ID_DEPRECATED
 virtual void SetSysWindow(const SysWindow sysWindow) = 0;
#endif

 typedef enum { kZoomedOut, kZoomedIn, kResetZoomedOut} ZoomState;
 
 virtual void Zoom(ZoomState zoomState, GSysRect *zoomRect) = 0;

 virtual ZoomState GetZoomState() const = 0;
 virtual void SetZoomState(ZoomState zoomState) = 0;
 
 virtual void SetVisible(VisibleState state, bool16 apply = kTrue) = 0;

 virtual VisibleState GetVisible() const = 0;

 virtual bool16 IsVisible() const = 0;

 virtual void VisibleStateChanged(VisibleState state) = 0;

 virtual void BringToFront() = 0;

 virtual void Activate() = 0;

 virtual void Deactivate() = 0;
 
 virtual bool16 IsActive() const = 0;

 typedef enum{ kLimitMinimumWidth, kLimitMaximumWidth, kLimitMinimumHeight, kLimitMaximumHeight } LimitType;

 virtual SysCoord GetLimits( const LimitType type ) const = 0;

 virtual void SetLimits( const LimitType type, const SysCoord newLimit) = 0;
 
 virtual void Paint(IViewPort* viewPort, SysRgn updateRgn) = 0;
 
 virtual void SystemPaint() = 0;

 virtual bool16 IsRolledUp(bool16& changed) const = 0;
 
 virtual bool16 DoesFloat() const = 0;
 
 virtual SysRgn SystemScroll(const SysPoint& delta, bool16 bDoInval = kTrue, SysRect *bbox = nil) = 0;
 
 virtual void ForceRedraw(SysRgn invalidRgnToAdopt, bool16 forceRedraw) = 0;

 virtual bool16 IsOnScreen() const = 0;
 
 virtual void EnsureOnScreen() = 0;

 virtual uint32 GetWindowPolicy() const = 0;

 virtual void SetWindowPolicy(uint32 policy) = 0;
 
 /* Set the drover theme on the top level window for Palette, Dialog or Document
 *
 */
 virtual void InitThemeForWindow() = 0;
};
 
DECLARE_BASE_TYPE(IWindow::WindowSpec);

#endif