ICJKGridSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Heath Lynn
// 
// $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 __ICJKGridSuite__
#define __ICJKGridSuite__

#include "IPMUnknown.h"
#include "IFilteredCJKGridCmdData.h"
#include "ICJKCharCountOptions.h"
#include "ICJKFrameGridDefaults.h"

#include "CJKGridID.h"
#include "PMRect.h"
#include "K2Vector.h"


//========================================================================================
// Forward declarations
//========================================================================================
class ICJKGridData;
class IFilteredCJKGridCmdData;
class CJKGridData;

//========================================================================================
// CLASS ICJKGriSuite
//========================================================================================

class ICJKGridSuite : public IPMUnknown
{

public:

 typedef struct
 {
 bool16 applyNumOfLines; 
 int32 numOfLines;
 bool16 applyCharsPerLine;
 int32 charsPerLine;
 bool16 applyNumOfColumns;
 int32 numOfColumns;
 bool16 applyColumnGutter;
 PMReal columnGutter;

 } ApplyData;


 enum { kDefaultIID = IID_ICJKGRIDSUITE };

 virtual void FreezeSelectionForModalDialog() = 0;

 virtual void ThawSelectionForModalDialog() = 0;
 
 virtual bool16 CanApplyCJKGrid( ) const = 0;
 
 virtual ErrorCode ApplyCJKGrid( ) = 0;

 virtual void GetFrameGridView(K2Vector<ICJKFrameGridDefaults::View> & frameGridViewVector, bool16 sortedAndUnique = kFalse ) const = 0;
 
 virtual ErrorCode SetFrameGridView( ICJKFrameGridDefaults::View view ) = 0;

 virtual ICJKCharCountOptions::Location GetCharCountLocation() const = 0;
 
 virtual PMReal GetCharacterCountSize() const =0;
 
 virtual ErrorCode SetCharacterCountOptions(ICJKCharCountOptions::Location location , const PMReal & size ) = 0;

 virtual bool16 ShouldEnablePasteWithoutCJKGrid( ) const = 0;

 virtual UID GetActiveNamedGrid() const = 0;
 
 virtual ErrorCode ApplyNamedGrid(UID namedGrid) = 0;

 virtual bool16 ShouldEnableFrameGrid( ) const = 0;
 
 virtual bool16 IsFrameGridDefaults( ) const = 0;
 
 virtual void GetFilteredGridData( IFilteredCJKGridCmdData * filteredGridData ) const = 0;
 
 virtual void GetLinesAndCharsPerLine(K2Vector<int32> & numberOfLinesVector, K2Vector<int32> & charsPerLineVector, bool16 sortedAndUnique = kFalse ) const = 0;
 
 virtual ErrorCode ApplyFrameGrid (IFilteredCJKGridCmdData * filteredGridData, 
 ApplyData applyData, 
 bool16 applyGridView, 
 ICJKFrameGridDefaults::View gridView,
 ICJKCharCountOptions::Location charCountLocation,
 const PMReal & charCountSize
 ) = 0;
 
 virtual void GetFrameSizeInfo ( PMString & outString,
 IFilteredCJKGridCmdData * filteredGridData, 
 ApplyData applyData
 ) = 0;

};

#endif