PDFTool  7.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 ()
 デストラクタ
 
PtlContent & operator= (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...
 
PtlTextBox & drawTextBox (const PtlRect &rectMM, ALIGN align, float width, float height)
 テキストボックスを描画。 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)
 フォームXObjectを描画。 More...
 
void drawForm (const PtlRect &rectMM, ALIGN align, const PtlParamDrawForm &paramDrawForm)
 フォームXObjectを描画。 More...
 
void drawFitForm (const PtlRect &rectMM, ALIGN align, const PtlParamDrawForm &paramDrawForm)
 フォームXObjectを描画。 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...
 
PtlEditElements & getEditElements (int flag)
 EditElementコンテナを取得。 More...
 
PtlEditElements & getEditElements ()
 EditElementコンテナを取得。 More...
 
PtlParamString extractText (const PtlParamExtractText &ptlParamExtractText)
 テキストを抽出。 More...
 

Detailed Description

ページに描画される内容(コンテント)を表現するクラスです。
コンテントには画像エレメント,テキストエレメントなどが含まれそれらが描画されることになります。

Member Enumeration Documentation

◆ ALIGN

enum PdfTk::PtlContent::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

enum PdfTk::PtlContent::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単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
radiusMM円の半径をmm単位で指定してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawCircle() [2/2]

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

円形を描画。

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

Parameters
rectMM円形の内接する矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawFitForm()

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

フォームXObjectを描画。

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

フォームXObjectについて
フォームXObjectはページのコンテント同様に、テキスト,パス,画像などを描画する為の命令が書かれた1つのコンテントです。
ページのコンテントにフォームXObjectの描画命令があると、ビューワはフォームXObject内のコンテントのエレメントを描画します。

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
alignフォームXObjectの配置指定。ALIGN_XXXのいずれか。
paramDrawForm描画パラメータ。
Exceptions
PtlException

◆ drawFitImage()

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

画像を描画。

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

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
align画像の配置指定。ALIGN_XXXのいずれか。
paramDrawImage描画パラメータ。
Exceptions
PtlException

◆ drawForm() [1/2]

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

フォームXObjectを描画。

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

フォームXObjectについて
フォームXObjectはページのコンテント同様に、テキスト,パス,画像などを描画する為の命令が書かれた1つのコンテントです。
ページのコンテントにフォームXObjectの描画命令があると、ビューワはフォームXObject内のコンテントのエレメントを描画します。

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
alignフォームXObjectの配置指定。ALIGN_XXXのいずれか。
page描画に使用するPDF文書のページ。
Exceptions
PtlException

◆ drawForm() [2/2]

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

フォームXObjectを描画。

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

フォームXObjectについて
フォームXObjectはページのコンテント同様に、テキスト,パス,画像などを描画する為の命令が書かれた1つのコンテントです。
ページのコンテントにフォームXObjectの描画命令があると、ビューワはフォームXObject内のコンテントのエレメントを描画します。

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
alignフォームXObjectの配置指定。ALIGN_XXXのいずれか。
paramDrawForm描画パラメータ。
Exceptions
PtlException

◆ drawImage()

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

画像を描画。

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

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
align画像の配置指定。ALIGN_XXXのいずれか。
paramDrawImage描画パラメータ。
Exceptions
PtlException

◆ drawLayer()

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

レイヤーを描画。

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

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
alignレイヤーの配置指定。ALIGN_XXXのいずれか。
paramDrawLayer描画パラメータ。
Exceptions
PtlException

◆ drawLine()

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

線を描画。

線を描画します。

Parameters
fromMM開始位置。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
toMM終了位置。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawRect()

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

矩形を描画。

矩形を描画します。

Parameters
rectMM描画矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawRoundRect()

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

丸角矩形を描画。

丸角矩形を描画します。

Parameters
rectMM描画矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
widthRoundMM丸角の幅。単位はmm
heightRoundMM丸角の高さ。単位はmm
paramDrawShape描画パラメータ。
Exceptions
PtlException

◆ drawTextBox()

PtlTextBox& PdfTk::PtlContent::drawTextBox ( const PtlRect &  rectMM,
ALIGN  align,
float  width,
float  height 
)

テキストボックスを描画。

テキストボックスを描画します。
テキストボックスが矩形より大きい場合は矩形のサイズに縮小されます。

Parameters
rectMM出力矩形。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
width幅。単位はmm。出力矩形の幅を超えた値を設定すると出力矩形の幅に切り詰められます。
height高さ。単位はmm。出力矩形の高さを超えた値を設定すると出力矩形の高さに切り詰められます。
Returns
textBox テキストボックス。
Exceptions
PtlException

◆ extractText()

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

テキストを抽出。

コンテントからテキストを抽出します。
抽出されるのはページに描画されている内容です。透明のテキストも対象になります。
※ 注意：
テキストはコンテントに記述されている順番に取得されるのでビューワで見える通りの文字の並びとは限りません。

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

◆ getEditElements() [1/2]

PtlEditElements& PdfTk::PtlContent::getEditElements ( )

EditElementコンテナを取得。

コンテントに描画されるエレメントのコンテナを取得します。
この関数が複数回呼ばれた場合、全てのPtlEditElementsは最後に呼ばれたものと同じになります。

Returns
EditElementコンテナ。
Exceptions
PtlException

◆ getEditElements() [2/2]

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

EditElementコンテナを取得。

コンテントに描画されるエレメントのコンテナを取得します。
取得されるエレメントはテキスト,画像,パス,シェイディングのみです。
取得されたエレメント更新に使用できません。更新する場合はパラメータのないgetEditElements()を使用してください。
この関数が複数回呼ばれた場合、全てのPtlEditElementsは最後に呼ばれたものと同じになります。

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単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
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単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
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単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。
alignテキストの配置指定。ALIGN_XXXのいずれか。
str文字列。
paramWriteString文字列出力パラメータ。
Exceptions
PtlException
Generated by   doxygen 1.8.18