KVIrc 5.2.6
Developer APIs
libkviwindow.cpp File Reference
#include "UserWindow.h"
#include "KviModule.h"
#include "KviConsoleWindow.h"
#include "KviOptions.h"
#include "KviIrcSocket.h"
#include "KviMainWindow.h"
#include "KviLocale.h"
#include "KviApplication.h"
#include "KviError.h"
#include "KviIrcView.h"
#include "KviInput.h"
#include "KviIconManager.h"
#include "KviModuleManager.h"
#include "KviMemory.h"
#include "KviChannelWindow.h"
#include <QTimer>
#include <map>
#include <vector>

Macros

#define GET_KVS_FNC_WINDOW_ID
 
#define GET_KVS_WINDOW_ID
 

Functions

static bool window_kvs_cmd_activate (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_clearOutput (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_close (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_demandAttention (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_dock (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_fake (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_highlight (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_insertInInputText (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_listtypes (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_savePropertiesAsDefault (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_setBackground (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_setCryptEngine (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_setInputText (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_setWindowTitle (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_splitView (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_undock (KviKvsModuleCommandCall *c)
 
static bool window_kvs_cmd_unsplitView (KviKvsModuleCommandCall *c)
 
static bool window_kvs_fnc_activityLevel (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_activityTemperature (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_caption (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_console (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_context (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_cryptEngine (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_exists (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_fake (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_hasInput (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_hasOutput (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_hasUserFocus (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_highlightLevel (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_inputText (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_isDocked (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_isSplitView (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_list (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_open (KviKvsModuleFunctionCall *c)
 
static bool window_kvs_fnc_type (KviKvsModuleFunctionCall *c)
 
static bool window_module_can_unload (KviModule *)
 
static bool window_module_cleanup (KviModule *)
 
static bool window_module_init (KviModule *m)
 

Variables

KVIRC_API std::map< QString, KviWindow * > g_pGlobalWindowDict
 
std::vector< UserWindow * > g_pUserWindowList
 

Macro Definition Documentation

◆ GET_KVS_FNC_WINDOW_ID

#define GET_KVS_FNC_WINDOW_ID
Value:
QString szWnd; \
KviWindow * pWnd; \
KVSM_PARAMETERS_BEGIN(c) \
KVSM_PARAMETER("window_id", KVS_PT_STRING, KVS_PF_OPTIONAL, szWnd) \
KVSM_PARAMETERS_END(c) \
if(c->parameterList()->count() == 0) \
{ \
pWnd = c->window(); \
} \
else \
{ \
pWnd = g_pApp->findWindow(szWnd.toUtf8().data()); \
if(!pWnd) \
return true; \
}
KVIRC_API KviApplication * g_pApp
Definition KviApplication.cpp:161
@ KVS_PT_STRING
Definition KviKvsParameterProcessor.h:42
#define KVS_PF_OPTIONAL
Definition KviKvsParameterProcessor.h:142
Base class for all windows in KVIrc.
Definition KviWindow.h:75

◆ GET_KVS_WINDOW_ID

#define GET_KVS_WINDOW_ID
Value:
QString szWnd; \
KviWindow * pWnd; \
KVSM_PARAMETERS_BEGIN(c) \
KVSM_PARAMETER("window_id", KVS_PT_STRING, KVS_PF_OPTIONAL, szWnd) \
KVSM_PARAMETERS_END(c) \
if(c->parameterList()->count() == 0) \
{ \
pWnd = c->window(); \
} \
else \
{ \
pWnd = g_pApp->findWindow(szWnd.toUtf8().data()); \
if(!pWnd) \
{ \
if(!c->hasSwitch('q', "quiet")) \
c->warning(__tr2qs("The window with ID '%s' doesn't exist"), szWnd.toUtf8().data()); \
return true; \
} \
}
#define __tr2qs(text)
Definition KviLocale.h:216

Referenced by window_kvs_cmd_activate(), window_kvs_cmd_clearOutput(), window_kvs_cmd_close(), window_kvs_cmd_demandAttention(), window_kvs_cmd_dock(), window_kvs_cmd_savePropertiesAsDefault(), window_kvs_cmd_splitView(), window_kvs_cmd_undock(), and window_kvs_cmd_unsplitView().

Function Documentation

◆ window_kvs_cmd_activate()

static bool window_kvs_cmd_activate ( KviKvsModuleCommandCall * c)
static

References GET_KVS_WINDOW_ID.

Referenced by window_module_init().

◆ window_kvs_cmd_clearOutput()

static bool window_kvs_cmd_clearOutput ( KviKvsModuleCommandCall * c)
static

◆ window_kvs_cmd_close()

static bool window_kvs_cmd_close ( KviKvsModuleCommandCall * c)
static

References GET_KVS_WINDOW_ID.

Referenced by window_module_init().

◆ window_kvs_cmd_demandAttention()

static bool window_kvs_cmd_demandAttention ( KviKvsModuleCommandCall * c)
static

References GET_KVS_WINDOW_ID.

Referenced by window_module_init().

◆ window_kvs_cmd_dock()

static bool window_kvs_cmd_dock ( KviKvsModuleCommandCall * c)
static

References GET_KVS_WINDOW_ID.

Referenced by window_module_init().

◆ window_kvs_cmd_fake()

static bool window_kvs_cmd_fake ( KviKvsModuleCommandCall * c)
static

Referenced by window_module_init().

◆ window_kvs_cmd_highlight()

◆ window_kvs_cmd_insertInInputText()

◆ window_kvs_cmd_listtypes()

static bool window_kvs_cmd_listtypes ( KviKvsModuleCommandCall * c)
static

◆ window_kvs_cmd_savePropertiesAsDefault()

static bool window_kvs_cmd_savePropertiesAsDefault ( KviKvsModuleCommandCall * c)
static

References GET_KVS_WINDOW_ID.

Referenced by window_module_init().

◆ window_kvs_cmd_setBackground()

◆ window_kvs_cmd_setCryptEngine()

◆ window_kvs_cmd_setInputText()

◆ window_kvs_cmd_setWindowTitle()

◆ window_kvs_cmd_splitView()

◆ window_kvs_cmd_undock()

static bool window_kvs_cmd_undock ( KviKvsModuleCommandCall * c)
static

References GET_KVS_WINDOW_ID.

Referenced by window_module_init().

◆ window_kvs_cmd_unsplitView()

◆ window_kvs_fnc_activityLevel()

static bool window_kvs_fnc_activityLevel ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_activityTemperature()

static bool window_kvs_fnc_activityTemperature ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_caption()

static bool window_kvs_fnc_caption ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_console()

static bool window_kvs_fnc_console ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_context()

static bool window_kvs_fnc_context ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_cryptEngine()

static bool window_kvs_fnc_cryptEngine ( KviKvsModuleFunctionCall * c)
static

COMPILE_CRYPT_SUPPORT

COMPILE_CRYPT_SUPPORT

References GET_KVS_FNC_WINDOW_ID, KviKvsModuleFunctionCall::returnValue(), and KviKvsVariant::setString().

Referenced by window_module_init().

◆ window_kvs_fnc_exists()

◆ window_kvs_fnc_fake()

static bool window_kvs_fnc_fake ( KviKvsModuleFunctionCall * c)
static

Referenced by window_module_init().

◆ window_kvs_fnc_hasInput()

static bool window_kvs_fnc_hasInput ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_hasOutput()

static bool window_kvs_fnc_hasOutput ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_hasUserFocus()

◆ window_kvs_fnc_highlightLevel()

static bool window_kvs_fnc_highlightLevel ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_inputText()

static bool window_kvs_fnc_inputText ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_isDocked()

static bool window_kvs_fnc_isDocked ( KviKvsModuleFunctionCall * c)
static

◆ window_kvs_fnc_isSplitView()

◆ window_kvs_fnc_list()

◆ window_kvs_fnc_open()

◆ window_kvs_fnc_type()

◆ window_module_can_unload()

static bool window_module_can_unload ( KviModule * )
static

References g_pUserWindowList.

◆ window_module_cleanup()

static bool window_module_cleanup ( KviModule * )
static

References g_pUserWindowList, and w.

◆ window_module_init()

Variable Documentation

◆ g_pGlobalWindowDict

◆ g_pUserWindowList