doom3-gpl
Doom 3 GPL source release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ListGUI.h
Go to the documentation of this file.
1 /*
2 ===========================================================================
3 
4 Doom 3 GPL Source Code
5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
6 
7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
8 
9 Doom 3 Source Code is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13 
14 Doom 3 Source Code is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18 
19 You should have received a copy of the GNU General Public License
20 along with Doom 3 Source Code. If not, see <http://www.gnu.org/licenses/>.
21 
22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code. If not, please request a copy in writing from id Software at the address below.
23 
24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
25 
26 ===========================================================================
27 */
28 
29 #ifndef __LISTGUI_H__
30 #define __LISTGUI_H__
31 
32 /*
33 ===============================================================================
34 
35  feed data to a listDef
36  each item has an id and a display string
37 
38 ===============================================================================
39 */
40 
41 class idListGUI {
42 public:
43  virtual ~idListGUI() { }
44 
45  virtual void Config( idUserInterface *pGUI, const char *name ) = 0;
46  virtual void Add( int id, const idStr& s ) = 0;
47  // use the element count as index for the ids
48  virtual void Push( const idStr& s ) = 0;
49  virtual bool Del( int id ) = 0;
50  virtual void Clear( void ) = 0;
51  virtual int Num( void ) = 0;
52  virtual int GetSelection( char *s, int size, int sel = 0 ) const = 0; // returns the id, not the list index (or -1)
53  virtual void SetSelection( int sel ) = 0;
54  virtual int GetNumSelections() = 0;
55  virtual bool IsConfigured( void ) const = 0;
56  // by default, any modification to the list will trigger a full GUI refresh immediately
57  virtual void SetStateChanges( bool enable ) = 0;
58  virtual void Shutdown( void ) = 0;
59 };
60 
61 #endif /* !__LISTGUI_H__ */
virtual void Add(int id, const idStr &s)=0
virtual int GetNumSelections()=0
virtual bool Del(int id)=0
virtual void SetStateChanges(bool enable)=0
GLdouble s
Definition: glext.h:2935
virtual int Num(void)=0
virtual void SetSelection(int sel)=0
virtual void Shutdown(void)=0
virtual int GetSelection(char *s, int size, int sel=0) const =0
virtual bool IsConfigured(void) const =0
virtual void Config(idUserInterface *pGUI, const char *name)=0
virtual void Clear(void)=0
const GLcharARB * name
Definition: glext.h:3629
GLsizeiptr size
Definition: glext.h:3112
virtual void Push(const idStr &s)=0
Definition: Str.h:116
virtual ~idListGUI()
Definition: ListGUI.h:43