KVIrc 5.2.6
Developer APIs
libkviuserlist.cpp File Reference
#include "KviModule.h"
#include "KviLocale.h"
#include "KviChannelWindow.h"
#include "KviUserListView.h"

Macros

#define GET_KVS_FNC_WINDOW_ID
 
#define GET_KVS_WINDOW_ID_AND_NICK
 

Functions

static bool userlist_kvs_cmd_ensureVisible (KviKvsModuleCommandCall *c)
 
static bool userlist_kvs_cmd_select (KviKvsModuleCommandCall *c)
 
static bool userlist_kvs_fnc_selected (KviKvsModuleFunctionCall *c)
 
static bool userlist_module_can_unload (KviModule *)
 
static bool userlist_module_cleanup (KviModule *)
 
static bool userlist_module_init (KviModule *m)
 

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; \
} \
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

Referenced by userlist_kvs_fnc_selected(), window_kvs_fnc_activityLevel(), window_kvs_fnc_activityTemperature(), window_kvs_fnc_caption(), window_kvs_fnc_console(), window_kvs_fnc_context(), window_kvs_fnc_cryptEngine(), window_kvs_fnc_exists(), window_kvs_fnc_hasInput(), window_kvs_fnc_hasOutput(), window_kvs_fnc_hasUserFocus(), window_kvs_fnc_highlightLevel(), window_kvs_fnc_inputText(), window_kvs_fnc_isDocked(), window_kvs_fnc_isSplitView(), and window_kvs_fnc_type().

◆ GET_KVS_WINDOW_ID_AND_NICK

#define GET_KVS_WINDOW_ID_AND_NICK
Value:
QString szWnd, szNick; \
KviWindow * pWnd; \
KVSM_PARAMETERS_BEGIN(c) \
KVSM_PARAMETER("nick", KVS_PT_NONEMPTYSTRING, 0, szNick) \
KVSM_PARAMETER("window_id", KVS_PT_STRING, KVS_PF_OPTIONAL, szWnd) \
KVSM_PARAMETERS_END(c) \
if(c->parameterList()->count() == 1) \
{ \
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; \
} \
} \
if(!pWnd) \
return true;
@ KVS_PT_NONEMPTYSTRING
Definition KviKvsParameterProcessor.h:43
#define __tr2qs(text)
Definition KviLocale.h:216

Referenced by userlist_kvs_cmd_ensureVisible(), and userlist_kvs_cmd_select().

Function Documentation

◆ userlist_kvs_cmd_ensureVisible()

static bool userlist_kvs_cmd_ensureVisible ( KviKvsModuleCommandCall * c)
static

◆ userlist_kvs_cmd_select()

static bool userlist_kvs_cmd_select ( KviKvsModuleCommandCall * c)
static

◆ userlist_kvs_fnc_selected()

◆ userlist_module_can_unload()

static bool userlist_module_can_unload ( KviModule * )
static

◆ userlist_module_cleanup()

static bool userlist_module_cleanup ( KviModule * )
static

◆ userlist_module_init()