ICellStylesFacade.h

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

#include "IPMUnknown.h"

#include "CelStyID.h"
#include "TableTypes.h"
#include "keyboarddefs.h"

class IStyleGroupHierarchy;
class ITableModel;
class IWorkspace;

class AttributeBossList;
class GlobalTime;

namespace Facade
{
 class ICellStylesFacade : public IPMUnknown
 {
 public:
 enum {kDefaultIID = IID_ICELLSTYLESFACADE};
 
 virtual ErrorCode CopyStylesToGroup(const UIDRef& whichGroup, 
 const UIDList& whichStyles) const = 0;

 virtual const IPMUnknown* QueryCellStyleHier(IDataBase* db, 
 const UID& startingStyle, 
 const ClassID& whichAttr, 
 const PMIID& iid
 /* const PMIID& cellAttrType = IID_ITABLEATTRIBUTES or IID_IVERTICALCELLSTYLEATTRIBUTES*/) const = 0;
 
 virtual ErrorCode GetCellStyleAttrsResolved(const UIDRef& cellStyle, 
 AttributeBossList& resolvedAttrs,
 const PMIID& attributeType) const = 0;
 
 virtual UID GetCellStyleParagraphStyle(const UIDRef& styleRef) const = 0;
 
 virtual ErrorCode GetOverridingParagraphStyles(const ITableModel* tableModel, 
 const GridAddress& cellAnchor, 
 UIDList& out_OverridingParaStyles,
 const UIDRef& styleToCheck = UIDRef::gNull) const = 0;
 
 virtual ErrorCode GetCellOverrides(const ITableModel* tableModel, 
 const GridAddress& whichCell, 
 AttributeBossList& out_Overrides,
 const UIDRef& styleToCheck = UIDRef::gNull) const = 0;
 
 virtual ErrorCode GetAllCellOverrides(const ITableModel* tableModel, 
 const GridAddress& whichCell, 
 AttributeBossList& out_Overrides) const = 0;
 
 virtual ErrorCode CreateNewStyleGroup(IWorkspace* workspace, 
 const PMString& groupName, 
 const UID& parentUID, 
 const int32 position, 
 UID* out_NewGroup = nil) const = 0;
 
 virtual UID GetRootCellStyle(IDataBase* db) const = 0;
 
 virtual ICommand* CreateEditCellStyleCmd(const UIDRef& cellStyleRef) const = 0;
 
 virtual ErrorCode RenameCellStyle(const UIDRef& whichStyle, 
 const PMString& newName) const = 0;
 
 virtual ErrorCode DuplicateCellStyle(const UIDRef& whichStyle, 
 UIDRef& out_NewStyle) const = 0;
 
 virtual ErrorCode DuplicateCellStyles(const UIDList& stylesToDuplicate) const = 0;
 
 virtual ErrorCode SetDefaultStyle(const UIDRef& defaultStyle) const = 0;
 
 virtual ErrorCode ApplyCellStyle(const UIDRef& whichStyle, 
 const UIDRef& tableModelRef, 
 const GridArea& whichArea, 
 const bool16 removeOverrides = kFalse,
 const bool16 applyParaStyle = kTrue) const = 0;
 
 virtual ErrorCode ApplyCellStyleAndClearAll(const UIDRef& whichStyle, 
 const UIDRef& tableModelRef, 
 const GridArea& whichArea) const = 0;
 
 virtual ErrorCode EditCellStyle(const PMString& styleName, 
 const AttributeBossList* styleAttrList, 
 IWorkspace* workspace, 
 const UID& styleUID,
 const UID& basedOnStyleUID,
 const VirtualKey shortcutKey = kVirtualNullKey, 
 const int16 modifiers = 0,
 const GlobalTime* shortcutTime = nil) const = 0;
 
 virtual ErrorCode DeleteCellStyle(const UIDRef& styleToDelete,
 const UID& replacementStyle = kInvalidUID,
 const bool16 preserveFormatting = kFalse) const = 0;
 
 virtual ErrorCode CreateCellStyle(IWorkspace* workspace, 
 const IStyleGroupHierarchy* parentHier, 
 const int32 position,
 const PMString& syleName, 
 UIDRef& outStyleRef, 
 const UID& basedOnStyle = kInvalidUID,
 const AttributeBossList* styleAttrs = nil,
 const VirtualKey shortcutKey = kVirtualNullKey, 
 const int16 modifiers = 0,
 const GlobalTime* shortcutTime = nil) const = 0;
 
 virtual ErrorCode CreateCellStyle(const UIDRef& tableModelRef, 
 const GridAddress& selectedAddress,
 const IStyleGroupHierarchy* parentHier = nil,
 const int32 stylePosition = -1) const = 0;
 
 virtual bool16 CanBreakLinkWithCellStyle(const ITableModel* tableModel, 
 const GridArea& whichArea) const = 0;
 
 virtual ErrorCode BreakLinkWithStyle(const UIDRef& tableModelRef, 
 const GridArea& whichArea) const = 0;
 
 virtual bool16 CanRedefineCellStyle(const ITableModel* tableModel, 
 const GridAddress& whichAddress) const = 0;
 
 virtual ErrorCode RedefineStyle(const UIDRef& tableModelRef, 
 const GridAddress& whichAddress) const = 0;
 
 virtual ErrorCode ClearCellStyleOverrides(const UIDRef& tableModelRef, 
 const GridArea& whichArea) const = 0;
 
 
 virtual ErrorCode ClearAllCellOverrides(const UIDRef& tableModelRef, 
 const GridArea& whichArea) const = 0;
 virtual ErrorCode GetSelectedCellStyles(const UIDRef& tableModelRef, 
 const GridArea& whichArea, 
 UIDList& out_SelectedStyles) const = 0;

 virtual bool16 ClearParaStyleOverride(const ITableModel* tableModel,
 const GridAddress& whichCell) const = 0;
 };
}
#endif