IXMLNodeSelectionSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Ryan Gano
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _IXMLNodeSelectionSuite_
#define _IXMLNodeSelectionSuite_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
#include "ShuksanID.h"
#include "IPMUnknown.h"
#include "XMediaUIID.h"
#include "XMLID.h"
#include "NodeID.h"
#include "ISelectionMessages.h"
#include "XMLAttributeReference.h"


//================================================================================================
//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
//#define IID_IXMLStructureSelection_ISUITE kShuksanPrefix + 128

class IXMLNodeSelectionSuite : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IXMLNODESELECTIONSUITE };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:

 virtual void SelectAttribute(const XMLAttributeReference& newItem, Selection::Action selectionMode) = 0;

 virtual void SelectAttribute(const K2Vector<XMLAttributeReference>* newItems, Selection::Action selectionMode) = 0;

 virtual void DeselectAttribute(const K2Vector<XMLAttributeReference>* itemsToDeselect) = 0;
// virtual void DeselectAllAttributeExcept (const XMLAttributeReference&, bool16) = 0;
// virtual void DeselectAllAttribute (bool16 drawit) = 0;


 virtual void SelectElement(const XMLReference& newItem, Selection::Action selectionMode) = 0;

 virtual void SelectElement(const K2Vector<XMLReference>* newItems, Selection::Action selectionMode) = 0;

 virtual void DeselectElement(const K2Vector<XMLReference>* itemsToDeselect) = 0;
// virtual void DeselectAllElementExcept (const XMLReference&, bool16) = 0;
// virtual void DeselectAllElement (bool16 drawit) = 0;


 virtual void Select (IPMUnknown* targetBoss, Selection::Action selectionMode) = 0;

 virtual void DeselectAll (bool8 notifyofSelectionChange = true) = 0;

 virtual void SelectAll (void) = 0;

 // Selection Utilities

 virtual bool16 IsElementSelected (const XMLReference& itemNode) = 0;

 virtual bool16 IsAttributeSelected (const XMLAttributeReference& itemNode) = 0;

 virtual bool16 IsEmpty (void) const = 0;

 // Structure Specific Utilities

 virtual bool16 IsMixedSelection () const = 0;


 virtual bool16 IsNonAttributeSelected() const = 0;

 virtual bool16 IsNonAttributeSelected(const XMLReference& itemNode) const = 0;


 virtual bool16 IsElementOnlySelection () const = 0;

 virtual bool16 IsSingleElementSelection () const = 0;


 virtual bool16 IsCommentOnlySelection() const = 0;

 virtual bool16 IsSingleCommentSelection() const = 0;


 virtual bool16 IsPIOnlySelection() const = 0;

 virtual bool16 IsSinglePISelection() const = 0;


 virtual bool16 IsAttributeOnlySelection () const = 0;

 virtual bool16 IsSingleAttributeSelection () const = 0;


 virtual bool16 AreAnyTextSnippetsSelected () const = 0;


 virtual bool16 IsDocElementSelected() const = 0;

 virtual bool16 IsRootElementSelected() const = 0;

 virtual bool16 IsDOCTYPEElementSelected() const = 0;
 };

class IXMLNodeSelectionSuiteMsgData
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum ActionType { kDeselectAll};
 
 //____________________________________________________________________________________________
 // Member Functions
 //____________________________________________________________________________________________
 virtual ActionType GetActionType (void) const = 0;
 virtual bool16 GetDrawIt (void) const = 0;
 };
 
#endif // _IXMLNodeSelectionSuite_