doom3-bfg/neo/ui/ListGUI.h

62 lines
2.6 KiB
C++

/*
===========================================================================
Doom 3 BFG Edition GPL Source Code
Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company.
This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").
Doom 3 BFG Edition Source Code is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Doom 3 BFG Edition Source Code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Doom 3 BFG Edition Source Code. If not, see <http://www.gnu.org/licenses/>.
In addition, the Doom 3 BFG Edition 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 BFG Edition Source Code. If not, please request a copy in writing from id Software at the address below.
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.
===========================================================================
*/
#ifndef __LISTGUI_H__
#define __LISTGUI_H__
/*
===============================================================================
feed data to a listDef
each item has an id and a display string
===============================================================================
*/
class idListGUI
{
public:
virtual ~idListGUI() { }
virtual void Config( idUserInterface* pGUI, const char* name ) = 0;
virtual void Add( int id, const idStr& s ) = 0;
// use the element count as index for the ids
virtual void Push( const idStr& s ) = 0;
virtual bool Del( int id ) = 0;
virtual void Clear() = 0;
virtual int Num() = 0;
virtual int GetSelection( char* s, int size, int sel = 0 ) const = 0; // returns the id, not the list index (or -1)
virtual void SetSelection( int sel ) = 0;
virtual int GetNumSelections() = 0;
virtual bool IsConfigured() const = 0;
// by default, any modification to the list will trigger a full GUI refresh immediately
virtual void SetStateChanges( bool enable ) = 0;
virtual void Shutdown() = 0;
};
#endif /* !__LISTGUI_H__ */