group__cursor__fns.htm

MINIGUI1.6开发API

</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Changes the current cursor. 
<p>
This function changes the current cursor to be <em>hcsr</em>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>hcsr</em>&nbsp;</td><td>The expected cursor handle. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The old cursor handle.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This function defined as a macro calling <em>SetCursorEx</em> with passing <em>set_def</em> as FALSE.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__cursor__fns.htm#ga10">SetCursorEx</a>, <a class="el" href="group__cursor__fns.htm#ga38">SetDefaultCursor</a> </dd></dl>

<p>
Definition at line <a class="el" href="minigui_8h-source.htm#l02685">2685</a> of file <a class="el" href="minigui_8h-source.htm">minigui.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ga38" doxytag="minigui.h::SetDefaultCursor"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define SetDefaultCursor          </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">hcsr&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;SetCursorEx (hcsr, TRUE)</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Changes the current cursor, and set it as the default cursor. 
<p>
This function changes the current cursor to be <em>hcsr</em>, and set it as the default cursor.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>hcsr</em>&nbsp;</td><td>The expected cursor handle. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The old cursor handle.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This function defined as a macro calling <em>SetCursorEx</em> with passing <em>set_def</em> as TRUE.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__cursor__fns.htm#ga10">SetCursorEx</a>, <a class="el" href="group__cursor__fns.htm#ga37">SetCursor</a> </dd></dl>

<p>
Definition at line <a class="el" href="minigui_8h-source.htm#l02702">2702</a> of file <a class="el" href="minigui_8h-source.htm">minigui.h</a>.    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ga6" doxytag="minigui.h::ClipCursor"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void GUIAPI ClipCursor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="struct__RECT.htm">RECT</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>prc</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>
Clips the cursor range. 
<p>
This function sets cursor's clipping rectangle. <em>prc</em> is the new clipping rectangle in screen coordinates. If <em>prc</em> is NULL, <em>ClipCursor</em> will disable cursor clipping.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>prc</em>&nbsp;</td><td>The clipping rectangle. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="ga2" doxytag="minigui.h::CreateCursor"></a><p>
<table class="mdTable" 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="group__handles.htm#ga4">HCURSOR</a> GUIAPI CreateCursor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap> <em>xhotspot</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>yhotspot</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>w</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>h</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="group__win32__types.htm#ga0">BYTE</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>pANDBits</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="group__win32__types.htm#ga0">BYTE</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>pXORBits</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>colornum</em></td>
        </tr>
        <tr>
          <td class="md"></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>
Creates a cursor from memory data. 
<p>
This function creates a cursor from memory data rather than cursor file. <em>xhotspot</em> and <em>yhotspot</em> specify the hotpot of the cursor, <em>w</em> and <em>h</em> are the width and the height of the cursor respectively. <em>pANDBits</em> and <em>pXORBits</em> are AND bitmask and XOR bitmask of the cursor. MiniGUI currently support mono-color cursor and 16-color cursor, <em>colornum</em> specifies the cursor's color depth. For mono-color, it should be 1, and for 16-color cursor, it should be 4.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>xhotspot</em>&nbsp;</td><td>The x-coordinate of the hotspot. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>yhotspot</em>&nbsp;</td><td>The y-coordinate of the hotspot. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>The width of the cursor. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>The height of the cursor. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pANDBits</em>&nbsp;</td><td>The pointer to AND bits of the cursor. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pXORBits</em>&nbsp;</td><td>The pointer to XOR bits of the cursor. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>colornum</em>&nbsp;</td><td>The bit-per-pixel of XOR bits.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Handle to the cursor, zero on error.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>MiniGUI only support 2-color or 16-color cursor. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="ga3" doxytag="minigui.h::DestroyCursor"></a><p>
<table class="mdTable" 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="group__simple__types.htm#ga0">BOOL</a> GUIAPI DestroyCursor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="group__handles.htm#ga4">HCURSOR</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>hcsr</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>
Destroys a cursor object. 
<p>
This function destroys a cursor object specified by <em>hcsr</em>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>hcsr</em>&nbsp;</td><td>Handle to the cursor.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>TRUE on success, otherwise FALSE. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="ga7" doxytag="minigui.h::GetClipCursor"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void GUIAPI GetClipCursor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct__RECT.htm">RECT</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>prc</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>
Gets the current cursor clipping rectangle. 
<p>
This function copies the current clipping rectangle to a RECT pointed to by <em>prc</em>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>prc</em>&nbsp;</td><td>The clipping rectangle will be saved to this rectangle. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="ga5" doxytag="minigui.h::GetCurrentCursor"></a><p>
<table class="mdTable" 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="group__handles.htm#ga4">HCURSOR</a> GUIAPI GetCurrentCursor           </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>
Gets the handle to the current cursor. 
<p>
This function retrives the current cursor and returns its handle.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Handle to the current system cursor, zero means no current cursor. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="ga8" doxytag="minigui.h::GetCursorPos"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void GUIAPI GetCursorPos           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct__POINT.htm">POINT</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>ppt</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>
Gets position of the current cursor. 
<p>
This function copies the current mouse cursor position to a POINT structure pointed to by <em>ppt</em>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">