conout.h Source File

00001 /*
00002     Copyright (C) 2000 by Jorrit Tyberghein
00003     Written by Michael Dale Long
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00018 */
00019 
00020 #ifndef __IVARIA_CONOUT_H__
00021 #define __IVARIA_CONOUT_H__
00022 
00023 #include <stdarg.h>
00024 #include "iutil/eventh.h"
00025 #include "iutil/comp.h"
00026 
00027 class csRect;
00028 struct iConsoleOutput;
00029 struct iTextureManager;
00030 struct iFont;
00031 
00033 enum
00034 {
00035   csConPageUp = -1,
00036   csConPageDown = -2,
00037   csConVeryTop = -3,
00038   csConVeryBottom = -4
00039 };
00040 
00041 enum
00042 {
00043   csConNoCursor = 0,
00044   csConNormalCursor,
00045   csConInsertCursor
00046 };
00047 
00048 SCF_VERSION (iConsoleWatcher, 0, 0, 1);
00049 
00054 struct iConsoleWatcher : public iBase
00055 {
00057   virtual void ConsoleVisibilityChanged(iConsoleOutput*, bool visible) = 0;
00058 };
00059 
00060 
00061 SCF_VERSION (iConsoleOutput, 2, 1, 0);
00062 
00068 struct iConsoleOutput : public iBase
00069 {
00079   virtual void PutText (const char *iText, ...) CS_GNUC_PRINTF (2, 3) = 0;
00080 
00084   virtual void PutTextV (const char *iText, va_list args)
00085       CS_GNUC_PRINTF (2, 0) = 0;
00086 
00088   virtual const char *GetLine (int iLine = -1) const = 0;
00089 
00094   virtual void Draw2D (csRect *oRect = NULL) = 0;
00095 
00100   virtual void Draw3D (csRect *oRect = NULL) = 0;
00101 
00106   virtual void Clear (bool iWipe = false) = 0;
00107 
00109   virtual void SetBufferSize (int iMaxLines) = 0;
00110 
00112   virtual bool GetTransparency () const = 0;
00114   virtual void SetTransparency (bool iTransp) = 0;
00115 
00117   virtual iFont *GetFont () const = 0;
00119   virtual void SetFont (iFont *Font) = 0;
00120 
00122   virtual int GetTopLine () const = 0;
00128   virtual void ScrollTo (int iTopLine, bool iSnap = true) = 0;
00129 
00131   virtual int GetCursorStyle () const = 0;
00133   virtual void SetCursorStyle (int iStyle) = 0;
00134 
00139   virtual void SetVisible (bool iShow) = 0;
00143   virtual bool GetVisible () = 0;
00144 
00152   virtual void AutoUpdate (bool iAutoUpdate) = 0;
00153 
00155   virtual void SetCursorPos (int iCharNo) = 0;
00156 
00158   virtual int GetMaxLineWidth () = 0;
00159 
00164   virtual void RegisterWatcher (iConsoleWatcher*) = 0;
00165 
00167   virtual bool PerformExtension (const char *iCommand, ...) = 0;
00168 
00170   virtual bool PerformExtensionV (const char *iCommand, va_list) = 0;
00171 };
00172 
00173 #endif // __IVARIA_CONOUT_H__