## Public API Reference

- Main Page
- Classes
- Files

# tools/celconsole.h

    00001 /*
    00002     Crystal Space Entity Layer
    00003     Copyright (C) 2006 by Jorrit Tyberghein
    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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
    00018 */
    00019
    00020 #ifndef __CEL_CELCONSOLE__
    00021 #define __CEL_CELCONSOLE__
    00022
    00023 #include "cstypes.h"
    00024 #include "csutil/scf.h"
    00025 #include "csutil/flags.h"
    00026 #include "csutil/stringarray.h"
    00027
    00028 struct iConsoleInput;
    00029 struct iConsoleOutput;
    00030
    00035 struct iCelConsoleCommand : public virtual iBase
    00036 {
    00037   SCF_INTERFACE (iCelConsoleCommand, 0, 0, 1);
    00038
    00042   virtual const char* GetCommand () = 0;
    00043
    00047   virtual const char* GetDescription () = 0;
    00048
    00052   virtual void Help () = 0;
    00053
    00059   virtual void Execute (const csStringArray& args) = 0;
    00060 };
    00061
    00065 struct iCelConsole : public virtual iBase
    00066 {
    00067   SCF_INTERFACE (iCelConsole, 0, 0, 1);
    00068
    00072   virtual iConsoleInput* GetInputConsole () = 0;
    00073
    00077   virtual iConsoleOutput* GetOutputConsole () = 0;
    00078
    00082   virtual void RegisterCommand (iCelConsoleCommand* command) = 0;
    00083 };
    00084
    00085 #endif // __CEL_CELCONSOLE__
    00086