Source of: /manual/en/function.haruannotation-setopened.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-setopened.php',

    1 => 'HaruAnnotation::setOpened',

  ),

  'up' => 

  array (

    0 => 'class.haruannotation.php',

    1 => 'The HaruAnnotation class',

  ),

  'prev' => 

  array (

    0 => 'function.haruannotation-seticon.php',

    1 => 'HaruAnnotation::setIcon',

  ),

  'next' => 

  array (

    0 => 'class.harudestination.php',

    1 => 'HaruDestination',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.haruannotation-setopened" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">HaruAnnotation::setOpened</h1>

  <p class="verinfo">(PECL haru &gt;= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruAnnotation::setOpened</span> &mdash; <span class="dc-title">Set the initial state of the annotation</span></p>



 </div>



 <a name="function.haruannotation-setopened.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::setOpened</b></span>

    ( <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$opened</tt></span>

   )</div>



  <p class="para rdfs-comment">

   Defines whether the annotation is initially displayed open.

   This function may be used with text annotations only.

  </p>

 </div>





 <a name="function.haruannotation-setopened.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">opened</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       <b><tt class="constant">TRUE</tt></b> means the annotation is initially displayed open, <b><tt class="constant">FALSE</tt></b> -

       means it&#039;s closed.

      </p>

     </dd>



    

   </dl>

<p>

  </p>



 </div>





 <a name="function.haruannotation-setopened.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-setopened.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(); ?>
Our source is open

Source of: /manual/en/function.haruannotation-setopened.php
