PaletteRef.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $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.
// 
// 
// This file contains the type used to represent various Palette entities in the OWL Palette world
// 
//========================================================================================

#ifndef __PaletteRef__
#define __PaletteRef__

// Preprocessor macros/constants
#define FIXME_OWL(comment) {ASSERT_FAIL(FORMAT_ARGS("FIXME_OWL: %s\n", comment));}

//Types
#if MACINTOSH
 #if ID_COCOA_ENABLE
 #include <Cocoa/Cocoa.h>
 typedef NSObject* OWLControlRef;
 typedef NSView* OWLLeafControlRef;
 typedef NSView* OSViewRef;
 #else
 typedef HIViewRef OWLControlRef;
 typedef HIViewRef OWLLeafControlRef;
 typedef HIViewRef OSViewRef;
#endif
#elif WINDOWS
 typedef HWND OWLControlRef;
 typedef HWND OWLLeafControlRef;
 typedef HWND OSViewRef;
#endif

class IXMLGenerator;
class IPaletteFactory;
class IControlView;

enum PaletteRefType
{
 kUnknownPaletteType,
 
 kRootPaletteNode = 1,
 
 kTabGroupClusterType_OBSOLETE, //keep so we don't disrupt the id values
 
 kDockType,
 
 kToolbarType,
 
 kControlBarType,
 
 kTabPaneType,
 
 kTabGroupType, 
 
 kTabPanelContainerType,
 
 kControlBarPaneType,
 
 // New types for OWL2
 
 kApplicationContainerType,
 
 kDocumentPresentationType
 
};

class PaletteRef
{
 public:
 typedef base_type data_type;

 PaletteRef(PaletteRefType type, OWLControlRef ref) : fRef(ref), fType(type) {}
 PaletteRef(PaletteRefType type) : fRef(NULL), fType(type) {}
 PaletteRef() : fRef(NULL), fType(kUnknownPaletteType) {}
 
 bool16 IsValid() const {return fRef != NULL && fType != kUnknownPaletteType;} 

 PaletteRefType GetPaletteRefType() const {return fType;} 

 OWLControlRef GetOWLControl() const {return fRef;}
 OWLLeafControlRef GetOWLLeafControl() const {return (OWLLeafControlRef) fRef;}

 bool16 operator==(const PaletteRef& other) const { return fType == other.fType && fRef == other.fRef; }
 bool16 operator!=(const PaletteRef& other) const { return fType != other.fType || fRef != other.fRef; }
 
 private:
 PaletteRefType fType;
 OWLControlRef fRef;
};

#endif // __PaletteRef__