source: GTP/trunk/Lib/Geom/OgreStuff/include/OgreConfigDialog.h @ 1809

Revision 1809, 2.9 KB checked in by gumbau, 18 years ago (diff)
RevLine 
[1809]1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4    (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2005 The OGRE Team
8Also see acknowledgements in Readme.html
9
10This program is free software; you can redistribute it and/or modify it under
11the terms of the GNU Lesser General Public License as published by the Free Software
12Foundation; either version 2 of the License, or (at your option) any later
13version.
14
15This program is distributed in the hope that it will be useful, but WITHOUT
16ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
18
19You should have received a copy of the GNU Lesser General Public License along with
20this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21Place - Suite 330, Boston, MA 02111-1307, USA, or go to
22http://www.gnu.org/copyleft/lesser.txt.
23-----------------------------------------------------------------------------
24*/
25#ifndef __ConfigDialog_H__
26#define __ConfigDialog_H__
27
28// Precompiler options
29#include "OgrePrerequisites.h"
30
31namespace Ogre {
32    /** Defines the behaviour of an automatic renderer configuration dialog.
33        @remarks
34            OGRE comes with it's own renderer configuration dialog, which
35            applications can use to easily allow the user to configure the
36            settings appropriate to their machine. This class defines the
37            interface to this standard dialog. Because dialogs are inherently
38            tied to a particular platform's windowing system, there will be a
39            different subclass for each platform.
40        @author
41            Steven J. Streeting
42    */
43    class _OgreExport ConfigDialog
44    {
45    public:
46        virtual ~ConfigDialog();
47       
48        /** Displays the dialog.
49            @remarks
50                This method displays the dialog and from then on the dialog
51                interacts with the user independently. The dialog will be
52                calling the relevant OGRE rendering systems to query them for
53                options and to set the options the user selects. The method
54                returns when the user closes the dialog.
55            @returns
56                If the user accepted the dialog, <b>true</b> is returned.
57            @par
58                If the user cancelled the dialog (indicating the application
59                should probably terminate), <b>false</b> is returned.
60            @see
61                RenderSystem
62        */
63        virtual bool display(void) = 0;
64    protected:
65        RenderSystem* mSelectedRenderSystem;
66    };
67
68    /// Defines the interface OgrePlatform.dll/OgrePlatform.so must implement
69    typedef void (*DLL_CREATECONFIGDIALOG)(ConfigDialog** ppDlg);
70
71}
72#endif
Note: See TracBrowser for help on using the repository browser.