source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ConfigDialog.html @ 657

Revision 657, 8.9 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ConfigDialog class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::ConfigDialog Class Reference</h1>Defines the behaviour of an automatic renderer configuration dialog. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreConfigDialog_8h-source.html">OgreConfigDialog.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ConfigDialog:
16<p><center><img src="classOgre_1_1ConfigDialog.png" usemap="#Ogre::ConfigDialog_map" border="0" alt=""></center>
17<map name="Ogre::ConfigDialog_map">
18<area href="classOgre_1_1GLXConfig.html" alt="Ogre::GLXConfig" shape="rect" coords="0,56,155,80">
19<area href="classOgre_1_1SDLConfig.html" alt="Ogre::SDLConfig" shape="rect" coords="165,56,320,80">
20<area href="classOgre_1_1SDLConfig.html" alt="Ogre::SDLConfig" shape="rect" coords="330,56,485,80">
21<area href="classOgre_1_1Win32ConfigDialog.html" alt="Ogre::Win32ConfigDialog" shape="rect" coords="495,56,650,80">
22</map>
23<a href="classOgre_1_1ConfigDialog-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
24<tr><td></td></tr>
25<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigDialog.html#Ogre_1_1ConfigDialoga0">~ConfigDialog</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigDialog.html#Ogre_1_1ConfigDialoga1">display</a> (void)=0</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Displays the dialog.  <a href="#Ogre_1_1ConfigDialoga1"></a><br><br></td></tr>
31<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigDialog.html#Ogre_1_1Win32ConfigDialogp1">mSelectedRenderSystem</a></td></tr>
33
34</table>
35<hr><a name="_details"></a><h2>Detailed Description</h2>
36Defines the behaviour of an automatic renderer configuration dialog.
37<p>
38<dl compact><dt><b>Remarks:</b></dt><dd>OGRE comes with it's own renderer configuration dialog, which applications can use to easily allow the user to configure the settings appropriate to their machine. This class defines the interface to this standard dialog. Because dialogs are inherently tied to a particular platform's windowing system, there will be a different subclass for each platform. </dd></dl>
39<dl compact><dt><b>Author:</b></dt><dd>Steven J. Streeting </dd></dl>
40
41<p>
42
43<p>
44Definition at line <a class="el" href="OgreConfigDialog_8h-source.html#l00043">43</a> of file <a class="el" href="OgreConfigDialog_8h-source.html">OgreConfigDialog.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
45<a class="anchor" name="Ogre_1_1ConfigDialoga0" doxytag="Ogre::ConfigDialog::~ConfigDialog" ></a><p>
46<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
47  <tr>
48    <td class="mdRow">
49      <table cellpadding="0" cellspacing="0" border="0">
50        <tr>
51          <td class="md" nowrap valign="top"> virtual Ogre::ConfigDialog::~<a class="el" href="classOgre_1_1ConfigDialog.html">ConfigDialog</a> </td>
52          <td class="md" valign="top">(&nbsp;</td>
53          <td class="mdname1" valign="top" nowrap>          </td>
54          <td class="md" valign="top">&nbsp;)&nbsp;</td>
55          <td class="md" nowrap><code> [virtual]</code></td>
56        </tr>
57
58      </table>
59    </td>
60  </tr>
61</table>
62<table cellspacing=5 cellpadding=0 border=0>
63  <tr>
64    <td>
65      &nbsp;
66    </td>
67    <td>
68
69<p>
70    </td>
71  </tr>
72</table>
73<hr><h2>Member Function Documentation</h2>
74<a class="anchor" name="Ogre_1_1ConfigDialoga1" doxytag="Ogre::ConfigDialog::display" ></a><p>
75<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
76  <tr>
77    <td class="mdRow">
78      <table cellpadding="0" cellspacing="0" border="0">
79        <tr>
80          <td class="md" nowrap valign="top"> virtual bool Ogre::ConfigDialog::display </td>
81          <td class="md" valign="top">(&nbsp;</td>
82          <td class="md" nowrap valign="top">void&nbsp;</td>
83          <td class="mdname1" valign="top" nowrap>          </td>
84          <td class="md" valign="top">&nbsp;)&nbsp;</td>
85          <td class="md" nowrap><code> [pure virtual]</code></td>
86        </tr>
87
88      </table>
89    </td>
90  </tr>
91</table>
92<table cellspacing=5 cellpadding=0 border=0>
93  <tr>
94    <td>
95      &nbsp;
96    </td>
97    <td>
98
99<p>
100Displays the dialog.
101<p>
102<dl compact><dt><b>Remarks:</b></dt><dd>This method displays the dialog and from then on the dialog interacts with the user independently. The dialog will be calling the relevant OGRE rendering systems to query them for options and to set the options the user selects. The method returns when the user closes the dialog. </dd></dl>
103<dl compact><dt><b>Returns:</b></dt><dd>If the user accepted the dialog, <b>true</b> is returned. </dd></dl>
104<dl compact><dt><b></b></dt><dd>If the user cancelled the dialog (indicating the application should probably terminate), <b>false</b> is returned. </dd></dl>
105<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a> </dd></dl>
106
107<p>
108Implemented in <a class="el" href="classOgre_1_1GLXConfig.html#Ogre_1_1GLXConfiga1">Ogre::GLXConfig</a>, <a class="el" href="classOgre_1_1SDLConfig.html#Ogre_1_1SDLConfiga1">Ogre::SDLConfig</a>, <a class="el" href="classOgre_1_1SDLConfig.html#Ogre_1_1SDLConfiga3">Ogre::SDLConfig</a>, and <a class="el" href="classOgre_1_1Win32ConfigDialog.html#Ogre_1_1Win32ConfigDialoga1">Ogre::Win32ConfigDialog</a>.    </td>
109  </tr>
110</table>
111<hr><h2>Member Data Documentation</h2>
112<a class="anchor" name="Ogre_1_1Win32ConfigDialogp1" doxytag="Ogre::ConfigDialog::mSelectedRenderSystem" ></a><p>
113<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
114  <tr>
115    <td class="mdRow">
116      <table cellpadding="0" cellspacing="0" border="0">
117        <tr>
118          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a>* <a class="el" href="classOgre_1_1ConfigDialog.html#Ogre_1_1Win32ConfigDialogp1">Ogre::ConfigDialog::mSelectedRenderSystem</a><code> [protected]</code>
119      </table>
120    </td>
121  </tr>
122</table>
123<table cellspacing=5 cellpadding=0 border=0>
124  <tr>
125    <td>
126      &nbsp;
127    </td>
128    <td>
129
130<p>
131
132<p>
133Definition at line <a class="el" href="OgreConfigDialog_8h-source.html#l00065">65</a> of file <a class="el" href="OgreConfigDialog_8h-source.html">OgreConfigDialog.h</a>.    </td>
134  </tr>
135</table>
136<hr>The documentation for this class was generated from the following file:<ul>
137<li><a class="el" href="OgreConfigDialog_8h-source.html">OgreConfigDialog.h</a></ul>
138<hr>
139<p>
140Copyright &copy; 2000-2005 by The OGRE Team<br />
141<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
142This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
143                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
144                <Work rdf:about="">
145                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
146        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
147                </Work>
148                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
149
150Last modified Sun Feb 12 13:00:16 2006
151</p>
152</body>
153</html>
Note: See TracBrowser for help on using the repository browser.