diff options
Diffstat (limited to 'vendor/vstsdk2.4/vstgui.sf/vstgui/Documentation/html/class_c_splash_screen.html')
| -rw-r--r-- | vendor/vstsdk2.4/vstgui.sf/vstgui/Documentation/html/class_c_splash_screen.html | 500 |
1 files changed, 500 insertions, 0 deletions
diff --git a/vendor/vstsdk2.4/vstgui.sf/vstgui/Documentation/html/class_c_splash_screen.html b/vendor/vstsdk2.4/vstgui.sf/vstgui/Documentation/html/class_c_splash_screen.html new file mode 100644 index 0000000..044c0d3 --- /dev/null +++ b/vendor/vstsdk2.4/vstgui.sf/vstgui/Documentation/html/class_c_splash_screen.html @@ -0,0 +1,500 @@ +<!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>VSTGUI: CSplashScreen Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.5 --> +<div class="tabs"> + <ul> + <li><a href="main.html"><span>Main Page</span></a></li> + <li id="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul></div> +<h1>CSplashScreen Class Reference</h1><!-- doxytag: class="CSplashScreen" --><!-- doxytag: inherits="CControl" --><code>#include <vstcontrols.h></code> +<p> +<p>Inheritance diagram for CSplashScreen: +<p><center><img src="class_c_splash_screen.png" usemap="#CSplashScreen_map" border="0" alt=""></center> +<map name="CSplashScreen_map"> +<area href="class_c_control.html" alt="CControl" shape="rect" coords="0,112,125,136"> +<area href="class_c_view.html" alt="CView" shape="rect" coords="0,56,125,80"> +<area href="class_c_reference_counter.html" alt="CReferenceCounter" shape="rect" coords="0,0,125,24"> +</map> +<a href="class_c_splash_screen-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#eac43a5412fed9e396c4fafe0f4d9bf6">CSplashScreen</a> (const <a class="el" href="struct_c_rect.html">CRect</a> &<a class="el" href="class_c_view.html#f7bd60b75b29d79b660a2859395c1a24">size</a>, <a class="el" href="class_c_control_listener.html">CControlListener</a> *<a class="el" href="class_c_control.html#d0b62cf0cd270bb58374f321620931ff">listener</a>, long <a class="el" href="class_c_control.html#e4d23e841d8e8804190027bce3180fa5">tag</a>, <a class="el" href="class_c_bitmap.html">CBitmap</a> *background, <a class="el" href="struct_c_rect.html">CRect</a> &<a class="el" href="class_c_splash_screen.html#d442e96217f03ceef1470ea530078bbc">toDisplay</a>, <a class="el" href="struct_c_point.html">CPoint</a> &<a class="el" href="class_c_splash_screen.html#7a86c157ee9713c34fbd7a1ee40f0c5a">offset</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#d52086dfe68f3c694484fa69bc2896ee">~CSplashScreen</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#85dac31c41497b8926ed0023d6aaeb9d">draw</a> (<a class="el" href="class_c_draw_context.html">CDrawContext</a> *)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">called if the view should draw itself <a href="#85dac31c41497b8926ed0023d6aaeb9d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#e1894bbdc1c5a6d950797638d8db7deb">hitTest</a> (const <a class="el" href="struct_c_point.html">CPoint</a> &where, const long buttons=-1)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">check if where hits this view <a href="#e1894bbdc1c5a6d950797638d8db7deb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#9c247c4d05c6173789395123133e1a29">mouse</a> (<a class="el" href="class_c_draw_context.html">CDrawContext</a> *pContext, <a class="el" href="struct_c_point.html">CPoint</a> &where, long button=-1)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">called if a mouse click event occurs <a href="#9c247c4d05c6173789395123133e1a29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#716b2be17a11808016e66bb9c556e651">unSplash</a> (<a class="el" href="class_c_draw_context.html">CDrawContext</a> *pContext=0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#41296ef22874af3ace3314793beec75e">setBitmapTransparency</a> (unsigned char transparency)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#c695ad443b1b4a268c2a1e935da23421">getBitmapTransparency</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct_c_point.html">CPoint</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#42d36c6ec66f9ba6eb7a41016eb6fac7">getOffset</a> () const </td></tr> + +<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_c_rect.html">CRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#d442e96217f03ceef1470ea530078bbc">toDisplay</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_c_rect.html">CRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#f80d845f100bc2a531946f4aaef0fbaa">keepSize</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_c_point.html">CPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#7a86c157ee9713c34fbd7a1ee40f0c5a">offset</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_splash_screen.html#a65289bf65d374ff72d0792857974b5d">bitmapTransparency</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +One click on its activated region and its pixmap is displayed, in this state the other control can not be used, an another click on the displayed area reinstalls the normal frame. This can be used to display a help view over the other views. +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="eac43a5412fed9e396c4fafe0f4d9bf6"></a><!-- doxytag: member="CSplashScreen::CSplashScreen" ref="eac43a5412fed9e396c4fafe0f4d9bf6" args="(const CRect &size, CControlListener *listener, long tag, CBitmap *background, CRect &toDisplay, CPoint &offset)" --><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">CSplashScreen::CSplashScreen </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="struct_c_rect.html">CRect</a> & </td> + <td class="mdname" nowrap> <em>size</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="class_c_control_listener.html">CControlListener</a> * </td> + <td class="mdname" nowrap> <em>listener</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>long </td> + <td class="mdname" nowrap> <em>tag</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="class_c_bitmap.html">CBitmap</a> * </td> + <td class="mdname" nowrap> <em>background</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="struct_c_rect.html">CRect</a> & </td> + <td class="mdname" nowrap> <em>toDisplay</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="struct_c_point.html">CPoint</a> & </td> + <td class="mdname" nowrap> <em>offset</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> + </td> + </tr> +</table> +<a class="anchor" name="d52086dfe68f3c694484fa69bc2896ee"></a><!-- doxytag: member="CSplashScreen::~CSplashScreen" ref="d52086dfe68f3c694484fa69bc2896ee" args="()" --><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">CSplashScreen::~CSplashScreen </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </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> + </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="85dac31c41497b8926ed0023d6aaeb9d"></a><!-- doxytag: member="CSplashScreen::draw" ref="85dac31c41497b8926ed0023d6aaeb9d" args="(CDrawContext *)" --><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 CSplashScreen::draw </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="class_c_draw_context.html">CDrawContext</a> * </td> + <td class="mdname1" valign="top" nowrap> </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> +called if the view should draw itself +<p> + +<p> +Implements <a class="el" href="class_c_control.html#476335c5c55d56d92af699fed279d371">CControl</a>. </td> + </tr> +</table> +<a class="anchor" name="c695ad443b1b4a268c2a1e935da23421"></a><!-- doxytag: member="CSplashScreen::getBitmapTransparency" ref="c695ad443b1b4a268c2a1e935da23421" args="() const " --><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">unsigned char CSplashScreen::getBitmapTransparency </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="42d36c6ec66f9ba6eb7a41016eb6fac7"></a><!-- doxytag: member="CSplashScreen::getOffset" ref="42d36c6ec66f9ba6eb7a41016eb6fac7" args="() const " --><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">const <a class="el" href="struct_c_point.html">CPoint</a>& CSplashScreen::getOffset </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="e1894bbdc1c5a6d950797638d8db7deb"></a><!-- doxytag: member="CSplashScreen::hitTest" ref="e1894bbdc1c5a6d950797638d8db7deb" args="(const CPoint &where, const long buttons=-1)" --><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">bool CSplashScreen::hitTest </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="struct_c_point.html">CPoint</a> & </td> + <td class="mdname" nowrap> <em>where</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const long </td> + <td class="mdname" nowrap> <em>buttons</em> = <code>-1</code></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +check if where hits this view +<p> + +<p> +Reimplemented from <a class="el" href="class_c_view.html#e1894bbdc1c5a6d950797638d8db7deb">CView</a>. </td> + </tr> +</table> +<a class="anchor" name="9c247c4d05c6173789395123133e1a29"></a><!-- doxytag: member="CSplashScreen::mouse" ref="9c247c4d05c6173789395123133e1a29" args="(CDrawContext *pContext, CPoint &where, long button=-1)" --><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 CSplashScreen::mouse </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="class_c_draw_context.html">CDrawContext</a> * </td> + <td class="mdname" nowrap> <em>pContext</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="struct_c_point.html">CPoint</a> & </td> + <td class="mdname" nowrap> <em>where</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>long </td> + <td class="mdname" nowrap> <em>button</em> = <code>-1</code></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +called if a mouse click event occurs +<p> + +<p> +Reimplemented from <a class="el" href="class_c_view.html#76e14b82f9c28184f1ea88837d3a0bab">CView</a>. </td> + </tr> +</table> +<a class="anchor" name="41296ef22874af3ace3314793beec75e"></a><!-- doxytag: member="CSplashScreen::setBitmapTransparency" ref="41296ef22874af3ace3314793beec75e" args="(unsigned char transparency)" --><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 CSplashScreen::setBitmapTransparency </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned char </td> + <td class="mdname1" valign="top" nowrap> <em>transparency</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> + </td> + </tr> +</table> +<a class="anchor" name="716b2be17a11808016e66bb9c556e651"></a><!-- doxytag: member="CSplashScreen::unSplash" ref="716b2be17a11808016e66bb9c556e651" args="(CDrawContext *pContext=0)" --><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 CSplashScreen::unSplash </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="class_c_draw_context.html">CDrawContext</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>pContext</em> = <code>0</code> </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> + </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="a65289bf65d374ff72d0792857974b5d"></a><!-- doxytag: member="CSplashScreen::bitmapTransparency" ref="a65289bf65d374ff72d0792857974b5d" args="" --><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">unsigned char <a class="el" href="class_c_splash_screen.html#a65289bf65d374ff72d0792857974b5d">CSplashScreen::bitmapTransparency</a><code> [protected]</code> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="f80d845f100bc2a531946f4aaef0fbaa"></a><!-- doxytag: member="CSplashScreen::keepSize" ref="f80d845f100bc2a531946f4aaef0fbaa" args="" --><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="struct_c_rect.html">CRect</a> <a class="el" href="class_c_splash_screen.html#f80d845f100bc2a531946f4aaef0fbaa">CSplashScreen::keepSize</a><code> [protected]</code> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="7a86c157ee9713c34fbd7a1ee40f0c5a"></a><!-- doxytag: member="CSplashScreen::offset" ref="7a86c157ee9713c34fbd7a1ee40f0c5a" args="" --><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="struct_c_point.html">CPoint</a> <a class="el" href="class_c_splash_screen.html#7a86c157ee9713c34fbd7a1ee40f0c5a">CSplashScreen::offset</a><code> [protected]</code> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="d442e96217f03ceef1470ea530078bbc"></a><!-- doxytag: member="CSplashScreen::toDisplay" ref="d442e96217f03ceef1470ea530078bbc" args="" --><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="struct_c_rect.html">CRect</a> <a class="el" href="class_c_splash_screen.html#d442e96217f03ceef1470ea530078bbc">CSplashScreen::toDisplay</a><code> [protected]</code> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="vstcontrols_8h.html">vstcontrols.h</a><li><a class="el" href="vstcontrols_8cpp.html">vstcontrols.cpp</a></ul> +<html> + +<head> + <title>Empty</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="Author" content="mario"> +</head> + +<body> + +<br/> +<hr width="100%" size="2" align="left" /> +<div align=left> +Copyright ©2006 <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies</u></a>. +All Rights Reserved. +</div> +</body> + +</html> |