campo-sirio/libraries/wxPG/propgrid/docs/html/classwxImageFileProperty.htm
mtollari 4db94043cb Patch level : 12.0 no-patch
Files correlati     : 
Commento            : Spostamento in libraries delle librerie esterne di Campo per una maggiore pulizia e organizzazione

git-svn-id: svn://10.65.10.50/branches/R_10_00@24150 c028cbd2-c16b-5b4b-a496-9718f37d4682
2017-10-26 09:11:15 +00:00

226 lines
15 KiB
HTML

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>wxPropertyGrid: wxImageFileProperty Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.htm"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.htm"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>wxImageFileProperty Class Reference</h1><!-- doxytag: class="wxImageFileProperty" --><!-- doxytag: inherits="wxFileProperty" -->
<p>Property representing image file(name).
<a href="#_details">More...</a></p>
<p><code>#include &lt;advprops.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for wxImageFileProperty:</div>
<div class="dynsection">
<div class="center">
<img src="classwxImageFileProperty.png" usemap="#wxImageFileProperty_map" alt=""/>
<map id="wxImageFileProperty_map" name="wxImageFileProperty_map">
<area href="classwxFileProperty.htm" alt="wxFileProperty" shape="rect" coords="0,56,130,80"/>
<area href="classwxPGProperty.htm" alt="wxPGProperty" shape="rect" coords="0,0,130,24"/>
</map>
</div>
</div>
<p><a href="classwxImageFileProperty-members.htm">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxImageFileProperty.htm#afbcc832078fc722b822f9289cd4366ba">OnCustomPaint</a> (wxDC &amp;dc, const wxRect &amp;rect, <a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> &amp;paintdata)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override to paint an image in front of the property value text or drop-down list item (but only if <a class="el" href="classwxPGProperty.htm#a8c4008c4d7d148bd06f9db590301df76" title="Returns size of the custom painted image in front of property.">wxPGProperty::OnMeasureImage</a> is overridden as well). <a href="#afbcc832078fc722b822f9289cd4366ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual wxSize&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxImageFileProperty.htm#aa569befa5e2e6fcb7cbe563ae2a01e53">OnMeasureImage</a> (int item) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns size of the custom painted image in front of property. <a href="#aa569befa5e2e6fcb7cbe563ae2a01e53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxImageFileProperty.htm#a42428291b8abba3e237d05f57c351ae5">OnSetValue</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This virtual function is called after m_value has been set. <a href="#a42428291b8abba3e237d05f57c351ae5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92f6409f4ecf6eb79bc7044df9dc9420"></a><!-- doxytag: member="wxImageFileProperty::wxImageFileProperty" ref="a92f6409f4ecf6eb79bc7044df9dc9420" args="(const wxString &amp;label=wxPG_LABEL, const wxString &amp;name=wxPG_LABEL, const wxString &amp;value=wxEmptyString)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>wxImageFileProperty</b> (const wxString &amp;label=wxPG_LABEL, const wxString &amp;name=wxPG_LABEL, const wxString &amp;value=wxEmptyString)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae81b7c55e0b13254af74e1946095f80b"></a><!-- doxytag: member="wxImageFileProperty::m_pBitmap" ref="ae81b7c55e0b13254af74e1946095f80b" args="" -->
wxBitmap *&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_pBitmap</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab42303a8371b09d52f1c9affd386fb50"></a><!-- doxytag: member="wxImageFileProperty::m_pImage" ref="ab42303a8371b09d52f1c9affd386fb50" args="" -->
wxImage *&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_pImage</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Property representing image file(name). </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afbcc832078fc722b822f9289cd4366ba"></a><!-- doxytag: member="wxImageFileProperty::OnCustomPaint" ref="afbcc832078fc722b822f9289cd4366ba" args="(wxDC &amp;dc, const wxRect &amp;rect, wxPGPaintData &amp;paintdata)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxImageFileProperty::OnCustomPaint </td>
<td>(</td>
<td class="paramtype">wxDC &amp;&nbsp;</td>
<td class="paramname"> <em>dc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxRect &amp;&nbsp;</td>
<td class="paramname"> <em>rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> &amp;&nbsp;</td>
<td class="paramname"> <em>paintdata</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override to paint an image in front of the property value text or drop-down list item (but only if <a class="el" href="classwxPGProperty.htm#a8c4008c4d7d148bd06f9db590301df76" title="Returns size of the custom painted image in front of property.">wxPGProperty::OnMeasureImage</a> is overridden as well). </p>
<p>If property's <a class="el" href="classwxImageFileProperty.htm#aa569befa5e2e6fcb7cbe563ae2a01e53" title="Returns size of the custom painted image in front of property.">OnMeasureImage()</a> returns size that has height != 0 but less than row height ( &lt; 0 has special meanings), <a class="el" href="classwxPropertyGrid.htm" title="wxPropertyGrid is a specialized two-column grid for editing properties such as strings...">wxPropertyGrid</a> calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case <a class="el" href="classwxImageFileProperty.htm#aa569befa5e2e6fcb7cbe563ae2a01e53" title="Returns size of the custom painted image in front of property.">OnMeasureImage()</a> returned higher height than row height).</p>
<p>NOTE: Following applies when <a class="el" href="classwxImageFileProperty.htm#aa569befa5e2e6fcb7cbe563ae2a01e53" title="Returns size of the custom painted image in front of property.">OnMeasureImage()</a> returns a "flexible" height ( using wxPG_FLEXIBLE_SIZE(W,H) macro), which implies variable height items: If rect.x is &lt; 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dc</em>&nbsp;</td><td>wxDC to paint on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rect</em>&nbsp;</td><td>Box reserved for custom graphics. Includes surrounding rectangle, if any. If x is &lt; 0, then this is a measure item call (see above). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>paintdata</em>&nbsp;</td><td><a class="el" href="structwxPGPaintData.htm" title="Contains information relayed to property&#39;s OnCustomPaint.">wxPGPaintData</a> structure with much useful data.</td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.</li>
<li>Due to technical reasons, rect's height will be default even if custom height was reported during measure call.</li>
<li>Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.</li>
<li>Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well. </li>
</ul>
</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classwxFileProperty.htm#ac5d74ec31b9f790d6cc8dcf06f5bd98d">GetValueAsString</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#ad0b00df4a3916cb80adfa1227c70baf4">wxPGProperty</a>.</p>
</div>
</div>
<a class="anchor" id="aa569befa5e2e6fcb7cbe563ae2a01e53"></a><!-- doxytag: member="wxImageFileProperty::OnMeasureImage" ref="aa569befa5e2e6fcb7cbe563ae2a01e53" args="(int item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual wxSize wxImageFileProperty::OnMeasureImage </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>item</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns size of the custom painted image in front of property. </p>
<p>This method must be overridden to return non-default value if OnCustomPaint is to be called. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>item</em>&nbsp;</td><td>Normally -1, but can be an index to the property's list of items. </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>Default behavior is to return wxSize(0,0), which means no image.</li>
<li>Default image width or height is indicated with dimension -1.</li>
<li>You can also return wxPG_DEFAULT_IMAGE_SIZE which equals wxSize(-1, -1). </li>
</ul>
</dd></dl>
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a8c4008c4d7d148bd06f9db590301df76">wxPGProperty</a>.</p>
</div>
</div>
<a class="anchor" id="a42428291b8abba3e237d05f57c351ae5"></a><!-- doxytag: member="wxImageFileProperty::OnSetValue" ref="a42428291b8abba3e237d05f57c351ae5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxImageFileProperty::OnSetValue </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This virtual function is called after m_value has been set. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>If m_value was set to Null variant (ie. unspecified value), <a class="el" href="classwxImageFileProperty.htm#a42428291b8abba3e237d05f57c351ae5" title="This virtual function is called after m_value has been set.">OnSetValue()</a> will not be called.</li>
<li>m_value may be of any variant type. Typically properties internally support only one variant type, and as such <a class="el" href="classwxImageFileProperty.htm#a42428291b8abba3e237d05f57c351ae5" title="This virtual function is called after m_value has been set.">OnSetValue()</a> provides a good opportunity to convert supported values into internal type.</li>
<li>Default implementation does nothing. </li>
</ul>
</dd></dl>
<p>Reimplemented from <a class="el" href="classwxFileProperty.htm#a7fa1939a2201238c3acf57620b28bb35">wxFileProperty</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>advprops.h</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sun Aug 22 12:42:14 2010 for wxPropertyGrid by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>