IColumns.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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 __ICOLUMNS__
#define __ICOLUMNS__

#define kMinColumnWidth 1

#define kMaxNumColumns 216

#define kMinNumColumns 1

#define kMaxGutter 1440.0

#define kMinGutter 0.0

#ifndef __ODFRC__ // when used for core resource compilation, provide just the parameter range constants

#include "IPMUnknown.h"
#include "SpreadID.h"
#include "PMReal.h"
#include "PMRect.h"
#include "K2Vector.h"
class IGeometry;

typedef K2Vector<PMReal> PMRealList;

class IColumns : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICOLUMNS };

 enum ColumnOrientation {
 kVerticalColumnOrientation = 0,
 kHorizontalColumnOrientation = 1,
 kRomanColumnOrientation = kVerticalColumnOrientation,
 kTraditionalCJKColumnOrientation = kHorizontalColumnOrientation
 };

 enum MasterColumnRequest { kRequestPerhapsInvalidFirstColumnData = 0, kRequestValidColumnData = 1};


 virtual void SetColumns(const PMRealList& pageCols) = 0; 

 virtual void GetColumns_(PMRealList *outputColumns, MasterColumnRequest wantMaster = kRequestValidColumnData) const= 0;

 virtual int32 GetNumberColumns_( MasterColumnRequest wantMaster = kRequestValidColumnData) const = 0;

 virtual void SetGutter(const PMReal& theGutter) = 0;

 virtual PMReal GetGutter_( MasterColumnRequest wantMaster = kRequestValidColumnData) const = 0;
 
 virtual void SetColumnOrientation_0( ColumnOrientation direction) = 0;
 
 virtual ColumnOrientation GetColumnOrientation_0( MasterColumnRequest wantMaster = kRequestValidColumnData) const= 0;

 virtual void ChangeColumnAtIndex(int32 columnIndex, const PMReal& newValue) = 0;

 virtual int32 GetColumnAtLocation_(const PMReal& location) const = 0;

 virtual PMRect GetNthColumnBoundingBox_(IGeometry *pageGeom, const int32 n, const PMRect& marginRect) const = 0;

 virtual void SetCustom(bool16 b) = 0;

 virtual void ResetColumns() = 0;
 
 virtual bool16 ColumnsAreValid_() const = 0;

 virtual void SetColumnsAreValid(bool16 valid) = 0;

 virtual bool16 ColumnsAreCustom_( MasterColumnRequest wantMaster = kRequestValidColumnData) const= 0;
 
 virtual void GetColumnAttributes_hmm( MasterColumnRequest wantMaster/* = kTrue*/, PMRealList *outputColumns/* = nil*/, PMReal* gutter/* = nil*/, ColumnOrientation* direction/* = nil*/, bool16* custom/* = nil*/, bool16* valid/* = nil*/) const= 0;
 
 virtual PMRect GetPageBoundingBox_(IGeometry *pageGeometry, const PMRect& marginRect) const = 0;
};
#endif // __ODFRC__

#endif