display_8h.html

BlueLab3 bluetooth API 说明文档

<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> enum <a class="el" href="display_8h.html#a8">DisplayScrollType</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
How should the display be scrolled. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a36a22" doxytag="DISPLAY_SCROLL_TYPE_NONE" ></a>DISPLAY_SCROLL_TYPE_NONE</em>&nbsp;</td><td>
Do not scroll. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a36a23" doxytag="DISPLAY_SCROLL_TYPE_ONEWAY_ONCE" ></a>DISPLAY_SCROLL_TYPE_ONEWAY_ONCE</em>&nbsp;</td><td>
Start to end, then stop. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a36a24" doxytag="DISPLAY_SCROLL_TYPE_RETURN_ONCE" ></a>DISPLAY_SCROLL_TYPE_RETURN_ONCE</em>&nbsp;</td><td>
Start to end and back, then stop. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a36a25" doxytag="DISPLAY_SCROLL_TYPE_ONEWAY_ENDLESS" ></a>DISPLAY_SCROLL_TYPE_ONEWAY_ENDLESS</em>&nbsp;</td><td>
Start to end, looping. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a36a26" doxytag="DISPLAY_SCROLL_TYPE_RETURN_ENDLESS" ></a>DISPLAY_SCROLL_TYPE_RETURN_ENDLESS</em>&nbsp;</td><td>
Start to end and back, looping. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a36a27" doxytag="DISPLAY_SCROLL_TYPE_LIMIT" ></a>DISPLAY_SCROLL_TYPE_LIMIT</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a28" doxytag="display.h::DisplayInit" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplayInit           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>number_of_icons</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="struct_icon.html">Icon</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>icons</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the display library. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>number_of_icons</em>&nbsp;</td><td>The number of user-supplied icons. </td></tr>
    <tr><td></td><td valign=top><em>icons</em>&nbsp;</td><td>The definition for those icons (can be NULL if number_of_icons is zero). </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a29" doxytag="display.h::DisplayClear" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplayClear           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clear the display and turn off all hard icons. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a30" doxytag="display.h::DisplayClearPart" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplayClearPart           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>clear_first</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>clear_last</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clear a range of display columns. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>clear_first</em>&nbsp;</td><td>First column to clear. </td></tr>
    <tr><td></td><td valign=top><em>clear_last</em>&nbsp;</td><td>Last column to clear (inclusive). </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a31" doxytag="display.h::DisplaySelectFont" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplaySelectFont           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="font_8h.html#a0">FontId</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>font</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Select the font to use. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>font</em>&nbsp;</td><td>The ID of the font (to be found in the fonts.app file). </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a32" doxytag="display.h::DisplayShowPrompt" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplayShowPrompt           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="font_8h.html#a1">ucs2char</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>prompt</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>prompt_len</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>prompt_first</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>prompt_last</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>left_to_right</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="display_8h.html#a8">DisplayScrollType</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>scroll_type</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Show a prompt. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>prompt</em>&nbsp;</td><td>The characters of the font, as an array of UCS-2 characters. </td></tr>
    <tr><td></td><td valign=top><em>prompt_len</em>&nbsp;</td><td>The number of characters in the prompt. </td></tr>
    <tr><td></td><td valign=top><em>prompt_first</em>&nbsp;</td><td>The first column to use for the prompt. </td></tr>
    <tr><td></td><td valign=top><em>prompt_last</em>&nbsp;</td><td>The last column to use for the prompt (inclusive). </td></tr>
    <tr><td></td><td valign=top><em>left_to_right</em>&nbsp;</td><td>TRUE to align to first column, FALSE to align to last. </td></tr>
    <tr><td></td><td valign=top><em>scroll_type</em>&nbsp;</td><td>How to scroll the prompt. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a33" doxytag="display.h::DisplayShowIcon" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplayShowIcon           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="display_8h.html#a9">IconId</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>i</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>icon_first</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>icon_last</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>left_to_right</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Show a user-defined icon. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>i</em>&nbsp;</td><td>Identifier for the icon (less than the number of icons passed to DisplayInit). </td></tr>
    <tr><td></td><td valign=top><em>icon_first</em>&nbsp;</td><td>First column to use for the icon. </td></tr>
    <tr><td></td><td valign=top><em>icon_last</em>&nbsp;</td><td>Last column to use for the icon. </td></tr>
    <tr><td></td><td valign=top><em>left_to_right</em>&nbsp;</td><td>TRUE to align to first column, FALSE to align to last. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a34" doxytag="display.h::DisplayShowHardwareIcon" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="display_8h.html#a7">DisplayResult</a> DisplayShowHardwareIcon           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="display_8h.html#a9">IconId</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>i</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>on</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Turn on/off a hard icon on the display. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>i</em>&nbsp;</td><td>The number of the hard icon to control. </td></tr>
    <tr><td></td><td valign=top><em>on</em>&nbsp;</td><td>TRUE to turn the icon on, FALSE to turn it off. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>

</body>
</html>