ITableStylesFacade.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 ITABLESTYLESFACADE_H
#define ITABLESTYLESFACADE_H

#include "IPMUnknown.h"
#include "TableTypes.h"
#include "TabStyID.h"
#include "keyboarddefs.h"

class IStyleGroupHierarchy;
class ITableModel;
class IWorkspace;

class AttributeBossList;
class GlobalTime;
namespace Facade
{
 class ITableStylesFacade : public IPMUnknown
 {
 public:
 enum {kDefaultIID = IID_ITABLESTYLESFACADE};

 virtual UID GetBasicTableStyle(IDataBase* db) const = 0;
 
 virtual ErrorCode CopyStylesToGroup(const UIDRef& whichGroup, 
 const UIDList& whichStyles) const = 0;

 virtual UID GetRegionalStyle(const IPMUnknown* tableModelBoss, 
 const GridAddress& address, 
 GridArea* runArea = nil) const = 0;
 
 virtual ErrorCode GetRegionalStylesInArea(const UIDRef& tableModelRef, 
 const GridArea& whichArea, 
 UIDList& out_RegionalStyleSet) const = 0;
 
 virtual ErrorCode GetTableStyleAttrsResolved(const UIDRef& tableStyle,
 AttributeBossList& out_ResolvedAttrs) const = 0;
 
 virtual UID GetRootTableStyle(IDataBase* db) const = 0;
 
 virtual ICommand* CreateEditTableStyleCmd(const UIDRef& tableStyleRef) const = 0;
 
 virtual ErrorCode SetDefaultStyle(const UIDRef& defaultStyle) const = 0;
 
 virtual ErrorCode CreateNewStyleGroup(IWorkspace* workspace,
 const PMString& groupName, 
 const UID& parentUID, 
 const int32 position, 
 UID* out_NewGroup = nil) const = 0;
 
 virtual ErrorCode RenameTableStyle(const UIDRef& whichStyle, 
 const PMString& newName) const = 0;

 virtual ErrorCode DuplicateTableStyles(const UIDList& stylesToDuplicate) const = 0;

 virtual bool16 CanBreakLinkWithStyle(const UIDRef& tableModelRef) const = 0;
 
 virtual bool16 CanBreakLinkWithStyle(const ITableModel* tableModel) const = 0;
 
 virtual ErrorCode BreakLinkWithStyle(const UIDRef& tableModel) const = 0;

 virtual ErrorCode ApplyTableStyle(const UIDRef& whichStyle,
 const UIDRef& tableModelRef, 
 const bool16 removeTableOverrides = kFalse,
 const bool16 removeCellStyle = kFalse) const = 0;

 virtual ErrorCode EditTableStyle(const PMString& styleName, 
 const AttributeBossList* attrList, 
 IWorkspace* workspace, 
 const UID& styleUID,
 const UID& basedOn,
 const VirtualKey shortcutKey = kVirtualNullKey, 
 const int16 modifiers = 0,
 const GlobalTime* shortcutTime = nil,
 const bool16 preserveRegionalFormatting = kFalse) const = 0;
 
 virtual ErrorCode CreateTableStyle(IWorkspace* workspace, 
 const IStyleGroupHierarchy* parentHier, 
 const int32 position,
 const PMString& styleName, 
 UIDRef& out_StyleRef,
 const UID& basedOnStyle = kInvalidUID, 
 const AttributeBossList* attrList = nil,
 const VirtualKey shortcut = kVirtualNullKey, 
 const int16 modifiers = 0,
 const GlobalTime* shortcutTime = nil) const = 0;

 virtual ErrorCode CreateNewTableStyle(const UIDRef& tableModel,
 const IStyleGroupHierarchy* parentHier = nil, 
 const int32 stylePosition = -1) const = 0;

 virtual ErrorCode DeleteTableStyle(const UIDRef& styleToDelete,
 const UID& replacementStyle, 
 const bool16 preserveFormatting = kFalse) const = 0;

 virtual ErrorCode GetLocalOverrides(const UIDRef& tableModel, 
 AttributeBossList& out_LocalOverrides) const = 0;

 virtual ErrorCode ClearLocalOverrides(const UIDRef& tableModel,
 const bool16 clearCellStyles = kFalse) const = 0;

 virtual ErrorCode GetTableStyle(const UIDRef& tableModel, 
 UID& out_TableStyle) const = 0;

 virtual bool16 HasLocalOverrides(const UIDRef& tableModel) const = 0;

 virtual bool16 CanRedefineTableStyle(const UIDRef& tableModelRef) const = 0;
 
 virtual bool16 CanRedefineTableStyle(const ITableModel* tableModel) const = 0;
 
 virtual ErrorCode RedefineTableStyle(const UIDRef& tableModel) const = 0;

 virtual ErrorCode DuplicateStyle(const UIDRef& styleToDup, 
 UIDRef& out_NewStyleRef) const = 0;
 };
}
#endif