PDFTool  6.0
Public Types | Public Member Functions | List of all members
PdfTk::PtlContent Class Reference

ページのキャンバスを表現するクラスです。 More...

#include <PtlContent.h>

Public Types

enum  ALIGN {
  ALIGN_TOP_LEFT = 1, ALIGN_TOP = 2, ALIGN_TOP_RIGHT = 3, ALIGN_LEFT = 4,
  ALIGN_CENTER = 5, ALIGN_RIGHT = 6, ALIGN_BOTTOM_LEFT = 7, ALIGN_BOTTOM = 8,
  ALIGN_BOTTOM_RIGHT = 9
}
 配置 More...
 
enum  GET_ELEMENT {
  GET_TEXT = 0x00000001, GET_IMAGE = 0x00000002, GET_PATH = 0x00000004, GET_SHADING = 0x00000008,
  GET_ALL = 0x0FFFFFFF
}
 エレメント取得タイプ。 More...
 

Public Member Functions

int getHandle () const
 
 PtlContent ()
 コンストラクタ More...
 
 PtlContent (const PtlContent &obj)
 コピーコンストラクタ More...
 
 ‾PtlContent ()
 デストラクタ
 
PtlContentoperator= (const PtlContent &obj)
 コピーオペレータ More...
 
void writeString (const PtlRect &rectMM, ALIGN align, const PtlParamString &str, const PtlParamWriteString &paramWriteString)
 文字列を出力。 More...
 
void writeString (const PtlRect &rectMM, ALIGN align, float angle, const PtlParamString &str, const PtlParamWriteString &paramWriteString)
 文字列を回転出力。 More...
 
void writeStringV (const PtlRect &rectMM, ALIGN align, const PtlParamString &str, const PtlParamWriteString &paramWriteString)
 縦書きの文字列を出力。 More...
 
void drawImage (const PtlRect &rectMM, ALIGN align, const PtlParamDrawImage &paramDrawImage)
 画像を描画。 More...
 
void drawFitImage (const PtlRect &rectMM, ALIGN align, const PtlParamDrawImage &paramDrawImage)
 画像を描画。 More...
 
void drawForm (const PtlRect &rectMM, ALIGN align, const PtlPage &page)
 フォームを描画。 More...
 
void drawForm (const PtlRect &rectMM, ALIGN align, const PtlParamDrawForm &paramDrawForm)
 フォームを描画。 More...
 
void drawFitForm (const PtlRect &rectMM, ALIGN align, const PtlParamDrawForm &paramDrawForm)
 フォームを描画。 More...
 
void drawLine (const PtlPoint &fromMM, const PtlPoint &toMM, const PtlParamDrawShape &paramDrawShape)
 線を描画。 More...
 
void drawRect (const PtlRect &rectMM, const PtlParamDrawShape &paramDrawShape)
 矩形を描画。 More...
 
void drawRoundRect (const PtlRect &rectMM, float widthRoundMM, float heightRoundMM, const PtlParamDrawShape &paramDrawShape)
 丸角矩形を描画。 More...
 
void drawCircle (const PtlRect &rectMM, const PtlParamDrawShape &paramDrawShape)
 円形を描画。 More...
 
void drawCircle (const PtlPoint &centerMM, float radiusMM, const PtlParamDrawShape &paramDrawShape)
 円を描画。 More...
 
void drawLayer (const PtlRect &rectMM, ALIGN align, const PtlParamDrawLayer &paramDrawLayer)
 レイヤーを描画。 More...
 
PtlEditElementsgetEditElements (int flag)
 EditElementコンテナを取得。 More...
 
PtlParamString extractText (const PtlParamExtractText &ptlParamExtractText)
 テキストを抽出。 More...
 

Detailed Description

ページのキャンバスを表現するクラスです。

Member Enumeration Documentation

◆ ALIGN

配置

Enumerator
ALIGN_TOP_LEFT 

左上

ALIGN_TOP 

中央上

ALIGN_TOP_RIGHT 

右上

ALIGN_LEFT 

中央左

ALIGN_CENTER 

中央

ALIGN_RIGHT 

中央右

ALIGN_BOTTOM_LEFT 

左下

ALIGN_BOTTOM 

中央下

ALIGN_BOTTOM_RIGHT 

右下

◆ GET_ELEMENT

エレメント取得タイプ。

Enumerator
GET_TEXT 

テキストを取得する。

GET_IMAGE 

画像を取得する。

GET_PATH 

パスを取得する。

GET_SHADING 

シェイディングを取得する。

GET_ALL 

全てのエレメントを取得する。

Constructor & Destructor Documentation

◆ PtlContent() [1/2]

PdfTk::PtlContent::PtlContent ( )

コンストラクタ

Exceptions
PtlException

◆ PtlContent() [2/2]

PdfTk::PtlContent::PtlContent ( const PtlContent obj)

コピーコンストラクタ

Parameters
objコピー元オブジェクト。
Exceptions
PtlException

Member Function Documentation

◆ drawCircle() [1/2]

void PdfTk::PtlContent::drawCircle ( const PtlPoint centerMM,
float  radiusMM,
const PtlParamDrawShape paramDrawShape 
)

円を描画。

指定した矩形に内接する円を描画します。

Parameters
centerMM円の中心点。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
radiusMM円の半径をmm単位で指定してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawCircle() [2/2]

void PdfTk::PtlContent::drawCircle ( const PtlRect rectMM,
const PtlParamDrawShape paramDrawShape 
)

円形を描画。

指定した矩形に内接する円形を描画します。
パラメーターのrectMMに正方形を指定すれば円を描画しますが、そうでなければ楕円を描画します。

Parameters
rectMM円形の内接する矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawFitForm()

void PdfTk::PtlContent::drawFitForm ( const PtlRect rectMM,
ALIGN  align,
const PtlParamDrawForm paramDrawForm 
)

フォームを描画。

フォームとしてページを描画します。
ページを矩形のサイズに合わせて拡大縮小して描画します。
ページの縦横比は維持されます。
ページ描画以外は欠落します(注釈など)。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
paramDrawForm描画パラメータ。
Exceptions
PtlException

◆ drawFitImage()

void PdfTk::PtlContent::drawFitImage ( const PtlRect rectMM,
ALIGN  align,
const PtlParamDrawImage paramDrawImage 
)

画像を描画。

画像を矩形のサイズに合わせて拡大縮小して描画します。
画像の縦横比は維持されます。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
paramDrawImage描画パラメータ。
Exceptions
PtlException

◆ drawForm() [1/2]

void PdfTk::PtlContent::drawForm ( const PtlRect rectMM,
ALIGN  align,
const PtlPage page 
)

フォームを描画。

フォームとしてページを描画します。
ページ描画以外は欠落します(注釈など)。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
page描画に使用するPDF文書のページ。
Exceptions
PtlException

◆ drawForm() [2/2]

void PdfTk::PtlContent::drawForm ( const PtlRect rectMM,
ALIGN  align,
const PtlParamDrawForm paramDrawForm 
)

フォームを描画。

フォームとしてページを描画します。
ページ描画以外は欠落します(注釈など)。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
paramDrawForm描画パラメータ。
Exceptions
PtlException

◆ drawImage()

void PdfTk::PtlContent::drawImage ( const PtlRect rectMM,
ALIGN  align,
const PtlParamDrawImage paramDrawImage 
)

画像を描画。

画像を描画します。
画像が矩形より大きい場合は矩形のサイズに縮小されます。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
paramDrawImage描画パラメータ。
Exceptions
PtlException

◆ drawLayer()

void PdfTk::PtlContent::drawLayer ( const PtlRect rectMM,
ALIGN  align,
const PtlParamDrawLayer paramDrawLayer 
)

レイヤーを描画。

レイヤーとしてページを描画します。
ページ描画以外は欠落します(注釈など)。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignレイヤーの配置指定。ALIGN_XXXのいずれか。
paramDrawLayer描画パラメータ。
Exceptions
PtlException

◆ drawLine()

void PdfTk::PtlContent::drawLine ( const PtlPoint fromMM,
const PtlPoint toMM,
const PtlParamDrawShape paramDrawShape 
)

線を描画。

線を描画します。

Parameters
fromMM開始位置。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
toMM終了位置。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawRect()

void PdfTk::PtlContent::drawRect ( const PtlRect rectMM,
const PtlParamDrawShape paramDrawShape 
)

矩形を描画。

矩形を描画します。

Parameters
rectMM描画矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawRoundRect()

void PdfTk::PtlContent::drawRoundRect ( const PtlRect rectMM,
float  widthRoundMM,
float  heightRoundMM,
const PtlParamDrawShape paramDrawShape 
)

丸角矩形を描画。

丸角矩形を描画します。

Parameters
rectMM描画矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
widthRoundMM丸角の幅。単位はmm
heightRoundMM丸角の高さ。単位はmm
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ extractText()

PtlParamString PdfTk::PtlContent::extractText ( const PtlParamExtractText ptlParamExtractText)

テキストを抽出。

Parameters
ptlParamExtractTextテキスト抽出パラメータ。
Returns
テキスト
Exceptions
PtlException

◆ getEditElements()

PtlEditElements& PdfTk::PtlContent::getEditElements ( int  flag)

EditElementコンテナを取得。

コンテントに描画されるエレメントのコンテナを取得します。

Parameters
flagエレメント取得フラグ。GET_XXXで指定。
Returns
EditElementコンテナ。
Exceptions
PtlException

◆ operator=()

PtlContent& PdfTk::PtlContent::operator= ( const PtlContent obj)

コピーオペレータ

Parameters
objコピー元オブジェクト。

◆ writeString() [1/2]

void PdfTk::PtlContent::writeString ( const PtlRect rectMM,
ALIGN  align,
const PtlParamString str,
const PtlParamWriteString paramWriteString 
)

文字列を出力。

矩形位置に出力します。
この矩形というのはテキストの開始位置を決める為に使用されます。
矩形のサイズよりテキストが大きいからと言って折り返されたり、縮小される訳ではないことに注意してください。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
str文字列。
paramWriteString文字列出力パラメータ。
Exceptions
PtlException

◆ writeString() [2/2]

void PdfTk::PtlContent::writeString ( const PtlRect rectMM,
ALIGN  align,
float  angle,
const PtlParamString str,
const PtlParamWriteString paramWriteString 
)

文字列を回転出力。

任意の角度で文字列を傾けて矩形位置に出力します。 この矩形というのはテキストの開始位置を決める為に使用されます。
矩形のサイズよりテキストが大きいからと言って折り返されたり、縮小される訳ではないことに注意してください。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
angle任意の角度で配置する。反時計回りが正の値。
str文字列。
paramWriteString文字列出力パラメータ。
Exceptions
PtlException

◆ writeStringV()

void PdfTk::PtlContent::writeStringV ( const PtlRect rectMM,
ALIGN  align,
const PtlParamString str,
const PtlParamWriteString paramWriteString 
)

縦書きの文字列を出力。

矩形位置に出力します。
この矩形というのはテキストの開始位置を決める為に使用されます。
矩形のサイズよりテキストが大きいからと言って折り返されたり、縮小される訳ではないことに注意してください。

Parameters
rectMM出力矩形。
表示矩形(ViewBox)上の座標値をmm単位で指定してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
str文字列。
paramWriteString文字列出力パラメータ。
Exceptions
PtlException