IKinsokuTable.h

//========================================================================================
// 
// $File$
// 
// Owner: emenning
// 
// $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 __IKinsokuTable__
#define __IKinsokuTable__


#include "IPMUnknown.h"
#include "CJKID.h"

class WideString;

class IKinsokuTable : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IKINSOKUTABLE };

 typedef enum { kKinsoku_CannotBeginLine = 0,
 kKinsoku_CannotEndLine,
 kKinsoku_Hanging,
 kKinsoku_Nonseparatable
 } KinsokuCharType;
 
 virtual void AddKinsokuBefore(const WideString& characters) = 0;
 virtual void AddKinsokuAfter(const WideString& characters) = 0;
 virtual void AddKinsokuHanging(const WideString& characters) = 0;
 virtual void AddKinsokuNotSeparate(const WideString& characters) = 0;
 
 virtual void GetKinsokuBefore(WideString& characters) const = 0;
 virtual void GetKinsokuAfter(WideString& characters) const = 0;
 virtual void GetKinsokuHanging(WideString& characters) const = 0;
 virtual void GetKinsokuNotSeparate(WideString& characters) const = 0;

 virtual bool16 NoBreakBefore(UTF32TextChar c) const = 0;
 virtual bool16 NoBreakAfter(UTF32TextChar c) const = 0;
 virtual bool16 IsHangingCharacter(UTF32TextChar c) const = 0;
 virtual bool16 IsNotSeparateCharacter(UTF32TextChar c) const = 0;

 virtual int32 KinsokuBeforeNum() const = 0;
 virtual int32 KinsokuAfterNum() const = 0;
 virtual int32 KinsokuHangingNum() const = 0;
 virtual int32 KinsokuNotSeparateNum() const = 0;

 virtual void Clear() = 0;
 virtual void ClearKinsokuBefore() = 0;
 virtual void ClearKinsokuAfter() = 0;
 virtual void ClearKinsokuHanging() = 0;
 virtual void ClearKinsokuNotSeparate() = 0;

 virtual UTF32TextChar GetOneKinsokuCharacter(const int32 index, KinsokuCharType type) const = 0;
 virtual void AppendOneKinsokuCharacter(const UTF32TextChar ch, KinsokuCharType type) = 0;

 virtual void CopyKinsokuTableData(const IKinsokuTable *from) = 0;

 virtual bool16 GetEditability() const = 0;
 virtual void SetEditability(bool16 editability) = 0;

 // Unused (for now)
 virtual void AddKinsokuBetween(const textchar *characters1, const textchar *characters2, int32 number) = 0;
 virtual bool16 NoBreakBetween(UTF32TextChar c1, UTF32TextChar c2) const = 0;
 virtual int32 NoBreakBetweenNum() const = 0;
 virtual void ClearNoBreakBetween() = 0;
};



#endif
 // __IKinsokuTable__