You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kvirc/src/modules/objects/class_listviewitem.cpp

422 lines
14 KiB

//mdm:
// File : class_ListViewItem.h
// Creation date : Thu Feb 1 14:39:48 CEST 2005
// by Tonino Imbesi(Grifisx) and Alessandro Carbone(Noldor)
//
// This file is part of the KVirc irc client distribution
// Copyright (C) 1999-2000 Szymon Stefanek (pragma at kvirc dot net)
//
// This program is FREE software. You can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your opinion) any later version.
//
// This program is distributed in the HOPE that it will be USEFUL,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, write to the Free Software Foundation,
// Inc. ,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#include "class_listviewitem.h"
#include "class_pixmap.h"
#include "kvi_error.h"
#include "kvi_debug.h"
#include "kvi_locale.h"
#include "kvi_iconmanager.h"
/*
@doc: listviewitem
@keyterms:
listview listviewitem class
@title:
listviewitem class
@type:
class
@short:
A listviewitem class
@inherits:
[class]listviewitem[/class]
@description:
The listviewitem class implements a list view item.
A list view item is a multi-column object capable of displaying itself in a [class]listview[/class].
To use this class you must instantiate it with another listviewitem or a [class]listview[/class]
as tqparent. The item will be automatically displayed.
You can set the text and a pixmap in each column and you can make it checkable
with [classfnc:listviewitem]$setCheckable[/classfnc]().
A checkable listviewitem will display a small check mark in the first column.
@functions:
!fn: $setText(<column:integer>,<text:string>)
Sets the text in column column to text, if column is a valid column number and text is different from the existing text.
!fn: <string> $text(<column:integer>)
Returs the text of the specified column.
!fn: $setPixmap(<column:integer>,<pixmap:hobject or imageID>)
Sets the pixmap in column column to pm, if pm is non-null and different from the current pixmap, and if column is non-negative.
Pixmap can be a Kvirc imageid, an image file or a [class]pixmap[/class] object.
!fn: $setRenameEnabled(<col:integer>,<bEnabled:boolean>)
If b is TRUE (1), this item can be in-place renamed in the column col by the user; otherwise it cannot be renamed in-place.
!fn: $setEnabled(<bEnabled:boolean>)
Enables or disables the item
!fn: $isEnabled()
Returns $true if this item is enabled and $false otherwise
!fn: $setOpen(<bOpen:boolean>)
Opens or closes the item to show its tqchildren items
!fn: $isOpen()
Returns the open state of this item
!fn: $setCheckable(<bCheckable:boolean>)
Makes this item checkable or not. This function should be called immediately
after the item creation: changing this property later at runtime may have
strange results (like the item being moved inside the list, text disappearing,
hidden tqchildren etc... don't do it :D ).
!fn: $isCheckable()
Returns $true if this item is checkable and $false otherwise
!fn: $setChecked(<bChecked:boolean>)
Sets this item to be checked or not. [classfnc:listviewitem]$setCheckable[/classfnc]() must
have been previously called.
!fn: $isChecked()
Returns the check status of this item. [classfnc:listviewitem]$setCheckable[/classfnc]() must
have been previously called.
!fn: <listviewitem> $firstChild()
Returns the first child item of this listviewitem or $null if this item has no tqchildren.
!fn: <listviewitem> $nextSibling()
Returns the next sibling item of this listviewitem or $null if there are no sibling items.
Next sibling stands for the item at the same tree level coming just after :)
*/
//===========================================================================================
KVSO_BEGIN_REGISTERCLASS(KviKvsObject_listviewitem,"listviewitem","object")
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setText",function_setText)
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"text",function_text)
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setPixmap",function_setPixmap);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setRenameEnabled",function_setRenameEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setEnabled",function_setEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"isEnabled",function_isEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setOpen",function_setOpen);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"isOpen",function_isOpen);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setCheckable",function_setCheckable);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"isCheckable",function_isCheckable);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"setChecked",function_setChecked);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"isChecked",function_isChecked);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"firstChild",function_firstChild);
KVSO_REGISTER_HANDLER(KviKvsObject_listviewitem,"nextSibling",function_nextSibling);
KVSO_END_REGISTERCLASS(KviKvsObject_listviewitem)
KVSO_BEGIN_CONSTRUCTOR(KviKvsObject_listviewitem,KviKvsObject)
m_pListViewItem = 0;
KVSO_END_CONSTRUCTOR(KviKvsObject_listviewitem)
KVSO_BEGIN_DESTRUCTOR(KviKvsObject_listviewitem)
if(m_pListViewItem)delete m_pListViewItem;
KVSO_END_CONSTRUCTOR(KviKvsObject_listviewitem)
bool KviKvsObject_listviewitem::init(KviKvsRunTimeContext * pContext,KviKvsVariantList *pParams)
{
if (!tqparentObject())
{
pContext->error(__tr2qs("The listviewitem cannot be tqparentless"));
return false;
}
if(tqparentObject()->inherits("KviKvsObject_listviewitem"))
{
m_pListViewItem = new KviKvsMdmStandardListViewItem(this,((KviKvsObject_listviewitem *)tqparentObject())->m_pListViewItem);
} else {
if(tqparentObject()->inherits("KviKvsObject_listview"))
m_pListViewItem = new KviKvsMdmStandardListViewItem(this,((KviTalListView *)tqparentScriptWidget()));
else {
pContext->error(__tr2qs("The tqparent of the listviewitem must be either another listviewitem or a listview"));
return false;
}
}
return true;
}
void KviKvsObject_listviewitem::childDestroyed()
{
if(m_pListViewItem == 0)return;
m_pListViewItem = 0;
die();
}
KviKvsMdmStandardListViewItem::KviKvsMdmStandardListViewItem(KviKvsObject_listviewitem * ob,KviTalListView * par)
:KviTalListViewItem(par), m_pMasterObject(ob)
{
}
KviKvsMdmStandardListViewItem::KviKvsMdmStandardListViewItem(KviKvsObject_listviewitem * ob,KviTalListViewItem * par)
:KviTalListViewItem(par), m_pMasterObject(ob)
{
}
KviKvsMdmStandardListViewItem::~KviKvsMdmStandardListViewItem()
{
if(m_pMasterObject)m_pMasterObject->childDestroyed();
}
KviKvsMdmCheckListViewItem::KviKvsMdmCheckListViewItem(KviKvsObject_listviewitem * ob,KviTalListView * par)
:KviTalCheckListItem(par,TQString(),KviTalCheckListItem::CheckBox), m_pMasterObject(ob)
{
}
KviKvsMdmCheckListViewItem::KviKvsMdmCheckListViewItem(KviKvsObject_listviewitem * ob,KviTalListViewItem * par)
:KviTalCheckListItem(par,TQString(),KviTalCheckListItem::CheckBox), m_pMasterObject(ob)
{
}
KviKvsMdmCheckListViewItem::~KviKvsMdmCheckListViewItem()
{
if(m_pMasterObject)m_pMasterObject->childDestroyed();
}
kvs_hobject_t KviKvsObject_listviewitem::itemToHandle(KviTalListViewItem * it)
{
if(!it)return (kvs_hobject_t)0;
KviKvsObject_listviewitem * pObject;
if(it->rtti() == 1)pObject = ((KviKvsMdmCheckListViewItem *)it)->masterObject();
else pObject = ((KviKvsMdmStandardListViewItem *)it)->masterObject();
if(!pObject)return (kvs_hobject_t)0;
return pObject->handle();
}
bool KviKvsObject_listviewitem::function_setText(KviKvsObjectFunctionCall *c)
{
kvs_uint_t uCol;
TQString szText;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("column",KVS_PT_UNSIGNEDINTEGER,0,uCol)
KVSO_PARAMETER("text",KVS_PT_STRING,0,szText)
KVSO_PARAMETERS_END(c)
if(m_pListViewItem)
m_pListViewItem->setText(uCol,szText);
return true;
}
bool KviKvsObject_listviewitem::function_firstChild(KviKvsObjectFunctionCall *c)
{
if(m_pListViewItem)
c->returnValue()->setHObject(itemToHandle(m_pListViewItem->firstChild()));
else
c->returnValue()->setHObject((kvs_hobject_t)0);
return true;
}
bool KviKvsObject_listviewitem::function_nextSibling(KviKvsObjectFunctionCall *c)
{
if(m_pListViewItem)
c->returnValue()->setHObject(itemToHandle(m_pListViewItem->nextSibling()));
else
c->returnValue()->setHObject((kvs_hobject_t)0);
return true;
}
bool KviKvsObject_listviewitem::function_setRenameEnabled(KviKvsObjectFunctionCall *c)
{
kvs_uint_t uCol;
bool bEnabled;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("column",KVS_PT_UNSIGNEDINTEGER,0,uCol)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
if(m_pListViewItem)
m_pListViewItem->setRenameEnabled(uCol,bEnabled);
return true;
}
bool KviKvsObject_listviewitem::function_setEnabled(KviKvsObjectFunctionCall *c)
{
bool bEnabled;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
if(m_pListViewItem)
m_pListViewItem->setEnabled(bEnabled);
return true;
}
bool KviKvsObject_listviewitem::function_isEnabled(KviKvsObjectFunctionCall *c)
{
if(!m_pListViewItem)
{
c->returnValue()->setBoolean(false);
return true;
}
c->returnValue()->setBoolean(m_pListViewItem->isEnabled());
return true;
}
bool KviKvsObject_listviewitem::function_setOpen(KviKvsObjectFunctionCall *c)
{
bool bEnabled;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
if(m_pListViewItem)
m_pListViewItem->setOpen(bEnabled);
return true;
}
bool KviKvsObject_listviewitem::function_isOpen(KviKvsObjectFunctionCall *c)
{
if(!m_pListViewItem)
{
c->returnValue()->setBoolean(false);
return true;
}
c->returnValue()->setBoolean(m_pListViewItem->isOpen());
return true;
}
bool KviKvsObject_listviewitem::function_setChecked(KviKvsObjectFunctionCall *c)
{
bool bChecked;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("bChecked",KVS_PT_BOOL,0,bChecked)
KVSO_PARAMETERS_END(c)
if(!m_pListViewItem)return true;
if(m_pListViewItem->rtti() != 1)return true; // not a TQCheckListItem
((KviKvsMdmCheckListViewItem *)m_pListViewItem)->setOn(bChecked);
return true;
}
bool KviKvsObject_listviewitem::function_isChecked(KviKvsObjectFunctionCall *c)
{
if(!m_pListViewItem)
{
c->returnValue()->setBoolean(false);
return true;
}
if(m_pListViewItem->rtti() != 1)
{
c->returnValue()->setBoolean(false);
return true;
}
c->returnValue()->setBoolean(((KviKvsMdmCheckListViewItem *)m_pListViewItem)->isOn());
return true;
}
bool KviKvsObject_listviewitem::function_setCheckable(KviKvsObjectFunctionCall *c)
{
bool bCheckable;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("bCheckable",KVS_PT_BOOL,0,bCheckable)
KVSO_PARAMETERS_END(c)
if(!m_pListViewItem)return true;
if(bCheckable)
{
if(m_pListViewItem->rtti() == 1)return true; // a TQCheckListItem already
KviTalListViewItem * pParent = m_pListViewItem->tqparent();
KviTalListView * pLV = (KviTalListView *)m_pListViewItem->listView();
// swap the items, so we don't die now
KviTalListViewItem * pThis = m_pListViewItem;
m_pListViewItem = 0;
delete pThis;
if(pParent)
m_pListViewItem = new KviKvsMdmCheckListViewItem(this,pParent);
else
m_pListViewItem = new KviKvsMdmCheckListViewItem(this,pLV);
} else {
if(m_pListViewItem->rtti() != 1)return true; // not a TQCheckListItem yet
KviTalListViewItem * pParent = m_pListViewItem->tqparent();
KviTalListView * pLV = (KviTalListView *)m_pListViewItem->listView();
// swap the items, so we don't die now
KviTalListViewItem * pThis = m_pListViewItem;
m_pListViewItem = 0;
delete pThis;
if(pParent)
m_pListViewItem = new KviKvsMdmStandardListViewItem(this,pParent);
else
m_pListViewItem = new KviKvsMdmStandardListViewItem(this,pLV);
}
return true;
}
bool KviKvsObject_listviewitem::function_isCheckable(KviKvsObjectFunctionCall *c)
{
if(!m_pListViewItem)
{
c->returnValue()->setBoolean(false);
return true;
}
c->returnValue()->setBoolean(m_pListViewItem->rtti() == 1);
return true;
}
bool KviKvsObject_listviewitem::function_text(KviKvsObjectFunctionCall *c)
{
kvs_uint_t uCol;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("column",KVS_PT_UNSIGNEDINTEGER,0,uCol)
KVSO_PARAMETERS_END(c)
if(m_pListViewItem)
c->returnValue()->setString(m_pListViewItem->text(uCol));
return true;
}
bool KviKvsObject_listviewitem::function_setPixmap(KviKvsObjectFunctionCall *c)
{
kvs_uint_t uCol;
KviKvsObject *obPixmap;
kvs_hobject_t obHpixmap;
KviKvsVariant * vPixmap;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("column",KVS_PT_UNSIGNEDINTEGER,0,uCol)
KVSO_PARAMETER("pixmap",KVS_PT_VARIANT,0,vPixmap)
KVSO_PARAMETERS_END(c)
TQPixmap *pix = 0;
if(vPixmap->isHObject())
{
vPixmap->asHObject(obHpixmap);
obPixmap=KviKvsKernel::instance()->objectController()->lookupObject(obHpixmap);
if (!obPixmap->inherits("KviKvsObject_pixmap"))
{
c->warning(__tr2qs("Pixmap object or image Id required"));
return true;
}
pix=((KviKvsObject_pixmap *)obPixmap)->getPixmap();
} else {
TQString szPix;
vPixmap->asString(szPix);
pix=g_pIconManager->getImage(szPix);
if(!pix)
{
c->warning(__tr2qs("Error occured: the suitable file '%Q' is not of the correct format or it is not a valid icon number."),&szPix);
return true;
}
}
m_pListViewItem->setPixmap(uCol,*pix);
return true;
}
#include "m_class_listviewitem.moc"