HaruAnnotation::setIcon
(PECL haru >= 0.0.1)
HaruAnnotation::setIcon — アノテーションのアイコンの形式を設定する
説明
bool HaruAnnotation::setIcon
( int
$icon
)アノテーションアイコンの形式を定義します。 この関数は、テキストアノテーションに対してのみ使用します。
パラメータ
-
icon -
アイコンの形式。以下のいずれかの値となります。
-
HaruAnnotation::ICON_COMMENT -
HaruAnnotation::ICON_KEY -
HaruAnnotation::ICON_NOTE -
HaruAnnotation::ICON_HELP -
HaruAnnotation::ICON_NEW_PARAGRAPH -
HaruAnnotation::ICON_PARAGRAPH -
HaruAnnotation::ICON_INSERT
-
返り値
成功した場合に TRUE を返します。
エラー / 例外
エラー時に HaruException をスローします。