src/Core/Editors/Editor.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *   Copyright (C) 2008 by Sverre Rabbelier                                *
00003  *   sverre@rabbelier.nl                                                   *
00004  *                                                                         *
00005  *   This program is free software; you can redistribute it and/or modify  *
00006  *   it under the terms of the GNU General Public License as published by  *
00007  *   the Free Software Foundation; either version 3 of the License, or     *
00008  *   (at your option) any later version.                                   *
00009  *                                                                         *
00010  *   This program 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         *
00013  *   GNU General Public License for more details.                          *
00014  *                                                                         *
00015  *   You should have received a copy of the GNU General Public License     *
00016  *   along with this program; if not, write to the                         *
00017  *   Free Software Foundation, Inc.,                                       *
00018  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
00019  ***************************************************************************/
00020 #pragma once
00021 
00029 #include "Types.h"
00030 #include "SavableTypes.h"
00031 
00037 class Editor
00038 {
00039 public:
00041         Editor(UBSocket* sock);
00042         
00044         virtual ~Editor(void);
00045 
00046 
00048         virtual void OnEmptyLine() {}
00049         
00059         virtual void OnLine(const std::string& line);
00060         
00062         virtual void OnFocus() { }
00063         
00064         
00066         virtual std::string name() = 0;
00067         
00069         virtual std::string prompt(); // { return Global::Get()->EmptyString; };
00070                 
00072         virtual std::string lookup(const std::string& action); // { return Global::Get()->EmptyString; };
00073         
00075         virtual void dispatch(const std::string& action, const std::string& argument) { return; };
00076         
00078         virtual bool canReceiveChannel(mud::ChannelPtr channel) const;
00079         
00081         virtual bool supportPrefixes() const;
00082         
00083         
00085         void Send(const std::string& msg);
00086         
00088         void Sendf(const char* format, ...);
00089         
00091         void Disconnect();
00092 
00093 protected:
00094         UBSocket* m_sock; 
00096 private:
00098         Editor(const Editor& rhs);
00099 };

Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo