Forum und email
HaruAnnotation::setHighlightMode

HaruAnnotation::setHighlightMode

(no version information, might be only in CVS)

HaruAnnotation::setHighlightMode -- Set the highlighting mode of the annotation

Popis

bool HaruAnnotation::setHighlightMode ( int mode )

Defines the appearance of the annotation when clicked. This function may be used with link annotations only.

Seznam parametrů

mode

The highlighting mode of the annotation. Can take only these values:

HaruAnnotation::NO_HIGHLIGHT - no highlighting.
HaruAnnotation::INVERT_BOX - invert the contents of the annotation.
HaruAnnotation::INVERT_BORDER - invert the border of the annotation.
HaruAnnotation::DOWN_APPEARANCE - dent the annotation.

Návratové hodnoty

Returns TRUE on success.

Errors/Exceptions

Throws HaruException on error.