1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxPreferencesPage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwx_preferences_page-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxPreferencesPage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/preferences.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for wxPreferencesPage:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classwx_preferences_page__inherit__graph.png" border="0" usemap="#wx_preferences_page_inherit__map" alt="Inheritance graph"/></div>
<map name="wx_preferences_page_inherit__map" id="wx_preferences_page_inherit__map">
<area shape="rect" id="node3" href="classwx_stock_preferences_page.html" title="Specialization of wxPreferencesPage useful for certain commonly used preferences page." alt="" coords="5,83,176,111"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>One page of preferences dialog. </p>
<p>This is the base class for implementation of application's preferences. Its methods return various properties of the page, such as title or icon. The actual page is created by <a class="el" href="classwx_preferences_page.html#a5b1dabcb4d9e86ce3613f7f32803b7e5" title="Create a window for this page.">CreateWindow()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_stock_preferences_page.html" title="Specialization of wxPreferencesPage useful for certain commonly used preferences page.">wxStockPreferencesPage</a></dd></dl>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxcore">wxCore</a></span></div><dl class="section since"><dt>Since</dt><dd>2.9.5 </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a75e85f05d5c78a918dc85a891b8f4c51"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_preferences_page.html#a75e85f05d5c78a918dc85a891b8f4c51">wxPreferencesPage</a> ()</td></tr>
<tr class="memdesc:a75e85f05d5c78a918dc85a891b8f4c51"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a75e85f05d5c78a918dc85a891b8f4c51"></a><br/></td></tr>
<tr class="separator:a75e85f05d5c78a918dc85a891b8f4c51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0f9be588887bf27451efdb1400d262e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_preferences_page.html#ae0f9be588887bf27451efdb1400d262e">~wxPreferencesPage</a> ()</td></tr>
<tr class="memdesc:ae0f9be588887bf27451efdb1400d262e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae0f9be588887bf27451efdb1400d262e"></a><br/></td></tr>
<tr class="separator:ae0f9be588887bf27451efdb1400d262e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf3db462208f700fff0fd99c66afd8d7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_preferences_page.html#aaf3db462208f700fff0fd99c66afd8d7">GetName</a> () const =0</td></tr>
<tr class="memdesc:aaf3db462208f700fff0fd99c66afd8d7"><td class="mdescLeft"> </td><td class="mdescRight">Return name of the page. <a href="#aaf3db462208f700fff0fd99c66afd8d7"></a><br/></td></tr>
<tr class="separator:aaf3db462208f700fff0fd99c66afd8d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05880595e8507b60eaea11d5addc71e6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_bitmap.html">wxBitmap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_preferences_page.html#a05880595e8507b60eaea11d5addc71e6">GetLargeIcon</a> () const =0</td></tr>
<tr class="memdesc:a05880595e8507b60eaea11d5addc71e6"><td class="mdescLeft"> </td><td class="mdescRight">Return 32x32 icon used for the page on some platforms. <a href="#a05880595e8507b60eaea11d5addc71e6"></a><br/></td></tr>
<tr class="separator:a05880595e8507b60eaea11d5addc71e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b1dabcb4d9e86ce3613f7f32803b7e5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_window.html">wxWindow</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_preferences_page.html#a5b1dabcb4d9e86ce3613f7f32803b7e5">CreateWindow</a> (<a class="el" href="classwx_window.html">wxWindow</a> *parent)=0</td></tr>
<tr class="memdesc:a5b1dabcb4d9e86ce3613f7f32803b7e5"><td class="mdescLeft"> </td><td class="mdescRight">Create a window for this page. <a href="#a5b1dabcb4d9e86ce3613f7f32803b7e5"></a><br/></td></tr>
<tr class="separator:a5b1dabcb4d9e86ce3613f7f32803b7e5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a75e85f05d5c78a918dc85a891b8f4c51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxPreferencesPage::wxPreferencesPage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="ae0f9be588887bf27451efdb1400d262e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual wxPreferencesPage::~wxPreferencesPage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5b1dabcb4d9e86ce3613f7f32803b7e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_window.html">wxWindow</a>* wxPreferencesPage::CreateWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_window.html">wxWindow</a> * </td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a window for this page. </p>
<p>The window will be placed into the preferences dialog in platform-specific manner. Depending on the platform, this method may be called before showing the preferences window, when switching to its tab or even more than once. Don't make assumptions about the number of times or the specific time when it is called.</p>
<p>The caller takes ownership of the window.</p>
<p><a class="el" href="classwx_panel.html" title="A panel is a window on which controls are placed.">wxPanel</a> is usually used, but doesn't have to be.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>Parent window to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a05880595e8507b60eaea11d5addc71e6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_bitmap.html">wxBitmap</a> wxPreferencesPage::GetLargeIcon </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 32x32 icon used for the page on some platforms. </p>
<p>Currently only used on OS X.</p>
<dl class="section note"><dt>Note</dt><dd>This method is only pure virtual on platforms that require it (OS X). On other platforms, it has default implementation that returns an invalid bitmap. The preprocessor symbol <code>wxHAS_PREF_EDITOR_ICONS</code> is defined if this method must be implemented. </dd></dl>
<p>Implemented in <a class="el" href="classwx_stock_preferences_page.html#a101c70125896adbc30a847e020f870c9">wxStockPreferencesPage</a>.</p>
</div>
</div>
<a class="anchor" id="aaf3db462208f700fff0fd99c66afd8d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_string.html">wxString</a> wxPreferencesPage::GetName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return name of the page. </p>
<p>The name is used for notebook tab's label, icon label etc., depending on the platform. </p>
<p>Implemented in <a class="el" href="classwx_stock_preferences_page.html#a7c4dce6247a07fbe418585539059b5c1">wxStockPreferencesPage</a>.</p>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:52 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|