📄 group__caret__fns.htm
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>MiniGUI V1.6.10 API Reference: Caret operations</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.2 --><div class="qindex"><a class="qindex" href="index.htm">Main Page</a> | <a class="qindex" href="modules.htm">Modules</a> | <a class="qindex" href="classes.htm">Alphabetical List</a> | <a class="qindex" href="annotated.htm">Data Structures</a> | <a class="qindex" href="dirs.htm">Directories</a> | <a class="qindex" href="files.htm">File List</a> | <a class="qindex" href="functions.htm">Data Fields</a> | <a class="qindex" href="globals.htm">Globals</a> | <a class="qindex" href="pages.htm">Related Pages</a></div><h1>Caret operations<br><small>[<a class="el" href="group__window__create__fns.htm">Window creating/destroying</a>]</small></h1><h2>Functions</h2><ul><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga0">CreateCaret</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd, <a class="el" href="struct__BITMAP.htm">PBITMAP</a> pBitmap, int nWidth, int nHeight)<dl class="el"><dd class="mdescRight">Creates a new shape for the system caret and assigns ownership of the caret to the specified window. <a href="#ga0"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga1">ChangeCaretSize</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd, int newWidth, int newHeight)<dl class="el"><dd class="mdescRight">Changes the size of the caret. <a href="#ga1"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga2">ActiveCaret</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd)<dl class="el"><dd class="mdescRight">Activates the caret owned by a window. <a href="#ga2"></a><br></dl><li>MG_EXPORT <a class="el" href="group__win32__types.htm#ga6">UINT</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga3">GetCaretBlinkTime</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd)<dl class="el"><dd class="mdescRight">Returns the elapsed time, in milliseconds, required to invert the caret's pixels. <a href="#ga3"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga4">SetCaretBlinkTime</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd, <a class="el" href="group__win32__types.htm#ga6">UINT</a> uTime)<dl class="el"><dd class="mdescRight">Sets the caret blink time to the specified number of milliseconds. <a href="#ga4"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga5">DestroyCaret</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd)<dl class="el"><dd class="mdescRight">Destroys a caret. <a href="#ga5"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga6">HideCaret</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd)<dl class="el"><dd class="mdescRight">Hides a caret. <a href="#ga6"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga7">ShowCaret</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd)<dl class="el"><dd class="mdescRight">Shows a caret. <a href="#ga7"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga8">SetCaretPos</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd, int x, int y)<dl class="el"><dd class="mdescRight">Moves the caret to a new position. <a href="#ga8"></a><br></dl><li>MG_EXPORT <a class="el" href="group__simple__types.htm#ga0">BOOL</a> GUIAPI <a class="el" href="group__caret__fns.htm#ga9">GetCaretPos</a> (<a class="el" href="group__handles.htm#ga1">HWND</a> hWnd, <a class="el" href="struct__POINT.htm">PPOINT</a> pPt)<dl class="el"><dd class="mdescRight">Gets the caret position. <a href="#ga9"></a><br></dl></ul><hr><h2>Function Documentation</h2><a class="anchor" name="ga2" doxytag="window.h::ActiveCaret"></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 ActiveCaret </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__handles.htm#ga1">HWND</a> </td> <td class="mdname1" valign="top" nowrap> <em>hWnd</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Activates the caret owned by a window. <p>This function activates the caret owned by the specified window <em>hWnd</em>. After activating the caret, the caret will begin flashing automatically.<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>hWnd</em> </td><td>The owner of the caret. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>TRUE on success, otherwise FALSE.</dd></dl><dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__caret__fns.htm#ga6">HideCaret</a>, <a class="el" href="group__caret__fns.htm#ga7">ShowCaret</a> </dd></dl> </td> </tr></table><a class="anchor" name="ga1" doxytag="window.h::ChangeCaretSize"></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 ChangeCaretSize </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__handles.htm#ga1">HWND</a> </td> <td class="mdname" nowrap> <em>hWnd</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>newWidth</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>newHeight</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Changes the size of the caret. <p>This function change the size of the caret owned by the specified window <em>hWnd</em>. Note that the new size of the caret should be smaller than the original size which is specified when you call <em>CreateCaret</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>hWnd</em> </td><td>The owner of the caret. </td></tr> <tr><td valign="top"></td><td valign="top"><em>newWidth</em> </td><td>The new width of the caret. </td></tr> <tr><td valign="top"></td><td valign="top"><em>newHeight</em> </td><td>The new height of the caret. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>TRUE on success, otherwise FALSE.</dd></dl><dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__caret__fns.htm#ga0">CreateCaret</a> </dd></dl> </td> </tr></table><a class="anchor" name="ga0" doxytag="window.h::CreateCaret"></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 CreateCaret </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__handles.htm#ga1">HWND</a> </td> <td class="mdname" nowrap> <em>hWnd</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="struct__BITMAP.htm">PBITMAP</a> </td> <td class="mdname" nowrap> <em>pBitmap</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>nWidth</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>nHeight</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Creates a new shape for the system caret and assigns ownership of the caret to the specified window. <p>This function creates a new shape for the system caret and assigns ownership of the caret to the specified window <em>hWnd</em>. The caret shape can be a line, a block, or a bitmap.<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>hWnd</em> </td><td>The owner of the caret. </td></tr> <tr><td valign="top"></td><td valign="top"><em>pBitmap</em> </td><td>The bitmap shape of the caret. It can be NULL. </td></tr> <tr><td valign="top"></td><td valign="top"><em>nWidth</em> </td><td>The width of the caret. </td></tr> <tr><td valign="top"></td><td valign="top"><em>nHeight</em> </td><td>The height of the caret. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>TRUE on success, otherwise FALSE.</dd></dl><dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__caret__fns.htm#ga2">ActiveCaret</a>, <a class="el" href="group__caret__fns.htm#ga1">ChangeCaretSize</a> </dd></dl> </td> </tr></table><a class="anchor" name="ga5" doxytag="window.h::DestroyCaret"></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 DestroyCaret </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__handles.htm#ga1">HWND</a> </td> <td class="mdname1" valign="top" nowrap> <em>hWnd</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Destroys a caret. <p>This function destroys the caret's current shape, frees the caret from the window, and removes the caret from the screen.<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>hWnd</em> </td><td>The owner of the caret. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>TRUE on success, otherwise FALSE.</dd></dl><dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__caret__fns.htm#ga0">CreateCaret</a> </dd></dl> </td> </tr></table><a class="anchor" name="ga3" doxytag="window.h::GetCaretBlinkTime"></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__win32__types.htm#ga6">UINT</a> GUIAPI GetCaretBlinkTime </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__handles.htm#ga1">HWND</a> </td> <td class="mdname1" valign="top" nowrap> <em>hWnd</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the elapsed time, in milliseconds, required to invert the caret's pixels. <p>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -