KVIrc  4.9.2
DeveloperAPIs
KviUserInput.h
Go to the documentation of this file.
1 #ifndef _KVI_USERINPUT_H_
2 #define _KVI_USERINPUT_H_
3 //=============================================================================
4 //
5 // File : KviUserInput.h
6 // Creation date : Sun 25 Sep 2005 05:27:57 by Szymon Stefanek
7 //
8 // This file is part of the KVIrc IRC Client distribution
9 // Copyright (C) 2005-2010 Szymon Stefanek <pragma at kvirc dot net>
10 //
11 // This program is FREE software. You can redistribute it and/or
12 // modify it under the terms of the GNU General Public License
13 // as published by the Free Software Foundation; either version 2
14 // of the License, or (at your option) any later version.
15 //
16 // This program is distributed in the HOPE that it will be USEFUL,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 // See the GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, write to the Free Software Foundation,
23 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 //
25 //=============================================================================
26 
33 #include "kvi_settings.h"
34 #include "KviQString.h"
35 #include "KviWindow.h"
36 
41 namespace KviUserInput
42 {
52  KVIRC_API bool parse(QString & szData, KviWindow * pWindow, const QString & szContext = KviQString::Empty, bool bUserFriendlyCommandline = false);
53 
62  KVIRC_API bool parseCommand(const QString & szData, KviWindow * pWindow, const QString & szContext = KviQString::Empty, bool bUserFriendlyCommandline = false);
63 
70  KVIRC_API void parseNonCommand(QString & szData, KviWindow * pWindow);
71 
77  KVIRC_API void escapeString(QString & szData);
78 
79  //bool parseCommandWithSingleArgument(const QString & szData, KviWindow * pWindow, const QString & szContext = KviQString::Empty);
80 }
81 
82 #endif //_KVI_USERINPUT_H_
void parseNonCommand(QString &szData, KviWindow *pWindow)
Parses the non command input data.
Definition: KviUserInput.cpp:103
#define KVIRC_API
Definition: kvi_settings.h:128
bool parseCommand(const QString &szData, KviWindow *pWindow, const QString &szContext, bool bUserFriendlyCommandline)
Returns true if the command run.
Definition: KviUserInput.cpp:82
const QString Empty
A global empty string (note that this is ALSO NULL under Qt 3.x)
Definition: KviQString.cpp:49
Base class for all windows in KVIrc.
Definition: KviWindow.h:74
Contains the KviWindow class.
bool parse(QString &szData, KviWindow *pWindow, const QString &szContext, bool bUserFriendlyCommandline)
Returns false if szData is a command and it fails to run.
Definition: KviUserInput.cpp:38
KVIRC_API void escapeString(QString &szData)
Escapes any kvs special character from a string.
This file contains compile time settings.
Helper functions for the QString class.