📄 classwgui_1_1ctooltip.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>wGui::CToolTip class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> </center><hr><h1>wGui::CToolTip Class Reference</h1><code>#include <<a class="el" href="wg__tooltip_8h-source.html">wg_tooltip.h</a>></code><p><p>Inheritance diagram for wGui::CToolTip:<p><center><img src="classwGui_1_1CToolTip.png" usemap="#wGui::CToolTip_map" border="0" alt=""></center><map name="wGui::CToolTip_map"><area href="classwGui_1_1CWindow.html" alt="wGui::CWindow" shape="rect" coords="0,56,138,80"><area href="classwGui_1_1CMessageClient.html" alt="wGui::CMessageClient" shape="rect" coords="0,0,138,24"></map><h2>Public Methods</h2><ul><li><a class="el" href="classwGui_1_1CToolTip.html#a0">CToolTip</a> (<a class="el" href="classwGui_1_1CWindow.html">CWindow</a> *pToolWindow, std::string sText, <a class="el" href="classwGui_1_1CRGBColor.html">CRGBColor</a> &FontColor=DEFAULT_LINE_COLOR, <a class="el" href="classwGui_1_1CRGBColor.html">CRGBColor</a> &BGColor=COLOR_WHITE, <a class="el" href="classwGui_1_1CFontEngine.html">CFontEngine</a> *pFontEngine=0)<li><a name="a1" doxytag="wGui::CToolTip::~CToolTip"></a>virtual <a class="el" href="classwGui_1_1CToolTip.html#a1">~CToolTip</a> (void)<dl class="el"><dd><font size=-1><em>Standard destructor.<br><br></em></font></dl><li>void <a class="el" href="classwGui_1_1CToolTip.html#a2">ShowTip</a> (const <a class="el" href="classwGui_1_1CPoint.html">CPoint</a> &DrawPoint)<li><a name="a3" doxytag="wGui::CToolTip::HideTip"></a>void <a class="el" href="classwGui_1_1CToolTip.html#a3">HideTip</a> (void)<dl class="el"><dd><font size=-1><em>Hides the tooltip.<br><br></em></font></dl><li><a name="a4" doxytag="wGui::CToolTip::Draw"></a>virtual void <a class="el" href="classwGui_1_1CToolTip.html#a4">Draw</a> (void) const<dl class="el"><dd><font size=-1><em>Renders the Window Text, and clips to the Window Rect.<br><br></em></font></dl><li>virtual void <a class="el" href="classwGui_1_1CToolTip.html#a5">MoveWindow</a> (const <a class="el" href="classwGui_1_1CPoint.html">CPoint</a> &MoveDistance)<li>virtual bool <a class="el" href="classwGui_1_1CToolTip.html#a6">HandleMessage</a> (<a class="el" href="classwGui_1_1CMessage.html">CMessage</a> *pMessage)</ul><h2>Protected Attributes</h2><ul><li><a name="n0" doxytag="wGui::CToolTip::m_pFontEngine"></a><a class="el" href="classwGui_1_1CFontEngine.html">CFontEngine</a> * <a class="el" href="classwGui_1_1CToolTip.html#n0">m_pFontEngine</a><dl class="el"><dd><font size=-1><em>A pointer to the font engine to use to render the text.<br><br></em></font></dl><li><a name="n1" doxytag="wGui::CToolTip::m_pRenderedString"></a>std::auto_ptr< <a class="el" href="classwGui_1_1CRenderedString.html">CRenderedString</a> > <a class="el" href="classwGui_1_1CToolTip.html#n1">m_pRenderedString</a><dl class="el"><dd><font size=-1><em>An autopointer to the rendered version of the string.<br><br></em></font></dl><li><a name="n2" doxytag="wGui::CToolTip::m_FontColor"></a><a class="el" href="classwGui_1_1CRGBColor.html">CRGBColor</a> <a class="el" href="classwGui_1_1CToolTip.html#n2">m_FontColor</a><dl class="el"><dd><font size=-1><em>The font color.<br><br></em></font></dl><li><a name="n3" doxytag="wGui::CToolTip::m_pToolWindow"></a><a class="el" href="classwGui_1_1CWindow.html">CWindow</a> * <a class="el" href="classwGui_1_1CToolTip.html#n3">m_pToolWindow</a><dl class="el"><dd><font size=-1><em>A pointer to the <a class="el" href="classwGui_1_1CWindow.html">CWindow</a> based object the tooltip is for.<br><br></em></font></dl><li><a name="n4" doxytag="wGui::CToolTip::m_pTimer"></a><a class="el" href="classwGui_1_1CTimer.html">CTimer</a> * <a class="el" href="classwGui_1_1CToolTip.html#n4">m_pTimer</a><dl class="el"><dd><font size=-1><em>A pointer to a timer so that tooltips only appear after the mouse has been motionless for a bit.<br><br></em></font></dl><li><a name="n5" doxytag="wGui::CToolTip::m_LastMousePosition"></a><a class="el" href="classwGui_1_1CPoint.html">CPoint</a> <a class="el" href="classwGui_1_1CToolTip.html#n5">m_LastMousePosition</a><dl class="el"><dd><font size=-1><em>The last mouse position.<br><br></em></font></dl><li><a name="n6" doxytag="wGui::CToolTip::m_BoundingRect"></a><a class="el" href="classwGui_1_1CRect.html">CRect</a> <a class="el" href="classwGui_1_1CToolTip.html#n6">m_BoundingRect</a><dl class="el"><dd><font size=-1><em>A <a class="el" href="classwGui_1_1CRect.html">CRect</a> that bounds the text.<br><br></em></font></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>A tooltip that can pop up over windows They are attached to an existing <a class="el" href="classwGui_1_1CWindow.html">CWindow</a> object, and watch for the mouse cursor to stop over the object. When the cursor stops, the tooltip makes itself visible. <p><p>Definition at line <a class="el" href="wg__tooltip_8h-source.html#l00043">43</a> of file <a class="el" href="wg__tooltip_8h-source.html">wg_tooltip.h</a>.<hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="wGui::CToolTip::CToolTip"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> wGui::CToolTip::CToolTip </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classwGui_1_1CWindow.html">CWindow</a> * </td> <td class="mdname" nowrap> <em>pToolWindow</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>sText</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classwGui_1_1CRGBColor.html">CRGBColor</a> & </td> <td class="mdname" nowrap> <em>FontColor</em> = DEFAULT_LINE_COLOR, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classwGui_1_1CRGBColor.html">CRGBColor</a> & </td> <td class="mdname" nowrap> <em>BGColor</em> = COLOR_WHITE, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classwGui_1_1CFontEngine.html">CFontEngine</a> * </td> <td class="mdname" nowrap> <em>pFontEngine</em> = 0</td> </tr> <tr> <td></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>Construct a new label <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>pToolWindow</em> </td><td>A pointer to the <a class="el" href="classwGui_1_1CWindow.html">CWindow</a> based object the tooltip is for </td></tr><tr><td valign=top><em>sText</em> </td><td>The label text </td></tr><tr><td valign=top><em>FontColor</em> </td><td>The color of the tooltip text </td></tr><tr><td valign=top><em>BGColor</em> </td><td>The color of the tooltip's background </td></tr><tr><td valign=top><em>pFontEngine</em> </td><td>A pointer to the font engine to use when drawing the tooltip If this is left out (or set to 0) it will use the default font engine specified by the <a class="el" href="classwGui_1_1CApplication.html">CApplication</a> (which must be set before instantiating this object) </td></tr></table></dl><p>Definition at line <a class="el" href="wg__tooltip_8cpp-source.html#l00030">30</a> of file <a class="el" href="wg__tooltip_8cpp-source.html">wg_tooltip.cpp</a>.<p>References <a class="el" href="wg__window_8h-source.html#l00194">wGui::CWindow::m_BGColor</a>, <a class="el" href="wg__tooltip_8h-source.html#l00089">m_BoundingRect</a>, <a class="el" href="wg__tooltip_8h-source.html#l00083">m_pFontEngine</a>, <a class="el" href="wg__tooltip_8h-source.html#l00084">m_pRenderedString</a>, <a class="el" href="wg__tooltip_8h-source.html#l00087">m_pTimer</a>, <a class="el" href="wg__window_8h-source.html#l00212">wGui::CWindow::m_sClassName</a>, and <a class="el" href="wg__window_8h-source.html#l00188">wGui::CWindow::m_sWindowText</a>. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a6" doxytag="wGui::CToolTip::HandleMessage"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool wGui::CToolTip::HandleMessage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classwGui_1_1CMessage.html">CMessage</a> * </td> <td class="mdname1" valign="top" nowrap> <em>pMessage</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>CTooltips handle MOUSE_MOVE and CTRL_TIMER messages <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>pMessage</em> </td><td>A pointer to the message </td></tr></table></dl><p>Reimplemented from <a class="el" href="classwGui_1_1CWindow.html#a27">wGui::CWindow</a>.<p>Definition at line <a class="el" href="wg__tooltip_8cpp-source.html#l00101">101</a> of file <a class="el" href="wg__tooltip_8cpp-source.html">wg_tooltip.cpp</a>.<p>References <a class="el" href="wg__message_8h-source.html#l00081">wGui::CMessage::Destination()</a>, <a class="el" href="wg__window_8h-source.html#l00062">wGui::CWindow::GetWindowRect()</a>, <a class="el" href="wg__tooltip_8cpp-source.html#l00075">HideTip()</a>, <a class="el" href="wg__rect_8cpp-source.html#l00167">wGui::CRect::HitTest()</a>, <a class="el" href="wg__window_8h-source.html#l00100">wGui::CWindow::IsVisible()</a>, <a class="el" href="wg__tooltip_8h-source.html#l00088">m_LastMousePosition</a>, <a class="el" href="wg__window_8h-source.html#l00200">wGui::CWindow::m_pParentWindow</a>, <a class="el" href="wg__tooltip_8h-source.html#l00087">m_pTimer</a>, <a class="el" href="wg__message_8h-source.html#l00078">wGui::CMessage::MessageType()</a>, <a class="el" href="wg__message_8h-source.html#l00156">wGui::CMouseMessage::Point</a>, <a class="el" href="wg__tooltip_8cpp-source.html#l00067">ShowTip()</a>, <a class="el" href="wg__timer_8cpp-source.html#l00055">wGui::CTimer::StartTimer()</a>, and <a class="el" href="wg__timer_8cpp-source.html#l00065">wGui::CTimer::StopTimer()</a>. </td> </tr></table><a name="a5" doxytag="wGui::CToolTip::MoveWindow"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void wGui::CToolTip::MoveWindow </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classwGui_1_1CPoint.html">CPoint</a> & </td> <td class="mdname1" valign="top" nowrap> <em>MoveDistance</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Move the window and any child windows <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>MoveDistance</em> </td><td>The relative distance to move the window </td></tr></table></dl><p>Reimplemented from <a class="el" href="classwGui_1_1CWindow.html#a4">wGui::CWindow</a>.<p>Definition at line <a class="el" href="wg__tooltip_8cpp-source.html#l00094">94</a> of file <a class="el" href="wg__tooltip_8cpp-source.html">wg_tooltip.cpp</a>.<p>References <a class="el" href="wg__tooltip_8h-source.html#l00089">m_BoundingRect</a>. </td> </tr></table><a name="a2" doxytag="wGui::CToolTip::ShowTip"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void wGui::CToolTip::ShowTip </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classwGui_1_1CPoint.html">CPoint</a> & </td> <td class="mdname1" valign="top" nowrap> <em>DrawPoint</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>Displays the tooltip <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>DrawPoint</em> </td><td>Where to poisition the top left corner of the tooltip </td></tr></table></dl><p>Definition at line <a class="el" href="wg__tooltip_8cpp-source.html#l00067">67</a> of file <a class="el" href="wg__tooltip_8cpp-source.html">wg_tooltip.cpp</a>.<p>References <a class="el" href="wg__tooltip_8h-source.html#l00089">m_BoundingRect</a>, <a class="el" href="wg__window_8cpp-source.html#l00151">wGui::CWindow::SetVisible()</a>, <a class="el" href="wg__window_8cpp-source.html#l00077">wGui::CWindow::SetWindowRect()</a>, and <a class="el" href="wg__window_8cpp-source.html#l00213">wGui::CWindow::StartDrawProc()</a>.<p>Referenced by <a class="el" href="wg__tooltip_8cpp-source.html#l00101">HandleMessage()</a>. </td> </tr></table><hr>The documentation for this class was generated from the following files:<ul><li><a class="el" href="wg__tooltip_8h-source.html">wg_tooltip.h</a><li><a class="el" href="wg__tooltip_8cpp-source.html">wg_tooltip.cpp</a></ul><hr><address style="align: right;"><small>Generated on Sat Oct 25 12:43:29 2003 for wGui by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.18 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -