neo/framework/EditField.h

   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 __EDITFIELD_H__
  30 #define __EDITFIELD_H__
  31
  32 /*
  33 ===============================================================================
  34
  35         Edit field
  36
  37 ===============================================================================
  38 */
  39
  40 const int MAX_EDIT_LINE = 256;
  41
  42 typedef struct autoComplete_s {
  43         bool                    valid;
  44         int                             length;
  45         char                    completionString[MAX_EDIT_LINE];
  46         char                    currentMatch[MAX_EDIT_LINE];
  47         int                             matchCount;
  48         int                             matchIndex;
  49         int                             findMatchIndex;
  50 } autoComplete_t;
  51
  52 class idEditField {
  53 public:
  54                                         idEditField();
  55                                         ~idEditField();
  56
  57         void                    Clear( void );
  58         void                    SetWidthInChars( int w );
  59         void                    SetCursor( int c );
  60         int                             GetCursor( void ) const;
  61         void                    ClearAutoComplete( void );
  62         int                             GetAutoCompleteLength( void ) const;
  63         void                    AutoComplete( void );
  64         void                    CharEvent( int c );
  65         void                    KeyDownEvent( int key );
  66         void                    Paste( void );
  67         char *                  GetBuffer( void );
  68         void                    Draw( int x, int y, int width, bool showCursor, const idMaterial *material );
  69         void                    SetBuffer( const char *buffer );
  70
  71 private:
  72         int                             cursor;
  73         int                             scroll;
  74         int                             widthInChars;
  75         char                    buffer[MAX_EDIT_LINE];
  76         autoComplete_t  autoComplete;
  77 };
  78
  79 #endif /* !__EDITFIELD_H__ */