HaruAnnotation::setIcon

(PECL haru >= 0.0.1)

HaruAnnotation::setIcon — Définit le style de l'icône de l'annotation

Description

HaruAnnotation::setIcon ( int $icon ) : bool

Définit le style de l'icône de l'annotation. Cette fonction ne peut être utilisée qu'avec les annotations.

Liste de paramètres

icon

Le style de l'icône. Peut prendre uniquement les valeurs suivantes :

  • HaruAnnotation::ICON_COMMENT
  • HaruAnnotation::ICON_KEY
  • HaruAnnotation::ICON_NOTE
  • HaruAnnotation::ICON_HELP
  • HaruAnnotation::ICON_NEW_PARAGRAPH
  • HaruAnnotation::ICON_PARAGRAPH
  • HaruAnnotation::ICON_INSERT

Valeurs de retour

Retourne TRUE en cas de succès.

Erreurs / Exceptions

Émet une exception HaruException en cas d'erreur.