Our source is open
The syntax highlighted source is automatically generated by PHP from
the plaintext script.
If you're interested in what's behind the several functions we
used, you can always take a look at the source of the following files:
Of course, if you want to see the source
of this page, we have it available.
You can also browse the SVN repository for this website on
svn.php.net.
Source of: /manual/en/function.haruannotation-sethighlightmode.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.haruannotation.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.haruannotation-sethighlightmode.php',
1 => 'HaruAnnotation::setHighlightMode',
),
'up' =>
array (
0 => 'class.haruannotation.php',
1 => 'The HaruAnnotation class',
),
'prev' =>
array (
0 => 'function.haruannotation-setborderstyle.php',
1 => 'HaruAnnotation::setBorderStyle',
),
'next' =>
array (
0 => 'function.haruannotation-seticon.php',
1 => 'HaruAnnotation::setIcon',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.haruannotation-sethighlightmode" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruAnnotation::setHighlightMode</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruAnnotation::setHighlightMode</span> — <span class="dc-title">Set the highlighting mode of the annotation</span></p>
</div>
<a name="function.haruannotation-sethighlightmode.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>HaruAnnotation::setHighlightMode</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span>
)</div>
<p class="para rdfs-comment">
Defines the appearance of the annotation when clicked.
This function may be used with link annotations only.
</p>
</div>
<a name="function.haruannotation-sethighlightmode.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The highlighting mode of the annotation. Can take only these values:
</p><ul class="simplelist">
<li class="member">
<b><tt class="constant">HaruAnnotation::NO_HIGHLIGHT</tt></b> - no
highlighting.
</li>
<li class="member">
<b><tt class="constant">HaruAnnotation::INVERT_BOX</tt></b> - invert the contents
of the annotation.
</li>
<li class="member">
<b><tt class="constant">HaruAnnotation::INVERT_BORDER</tt></b> - invert the
border of the annotation.
</li>
<li class="member">
<b><tt class="constant">HaruAnnotation::DOWN_APPEARANCE</tt></b> - dent the
annotation.
</li>
</ul><p>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.haruannotation-sethighlightmode.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success.
</p>
</div>
<a name="function.haruannotation-sethighlightmode.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.php" class="classname">HaruException</a> on error.</p>
</div>
</div><?php manual_footer(); ?>
