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_wrapper.cpp

270 lines
9.3 KiB

//mdm:
// File : class_wrapper.cpp
// Creation date : Fri Jan 28 14:21:48 CEST 2005
// by Tonino Imbesi(Grifisx) and Alessandro Carbone(Noldor)
//
// This file is part of the KVirc irc client distribution
// Copyright (C) 1999-2005 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_wrapper.h"
#include "kvi_error.h"
#include "kvi_debug.h"
#include "kvi_locale.h"
#include "kvi_iconmanager.h"
#include "class_widget.h"
#include <tqwidget.h>
#ifndef COMPILE_USE_QT4
#include <tqobjectlist.h>
#include <tqwidgetlist.h>
#endif
#include "kvi_app.h"
#include "kvi_frame.h"
/*
@doc: wrapper
@keyterms:
wrapper object class,
@title:
wrapper class
@type:
class
@short:
Provides a wrapper class that hooks to an existing TQt graphic object modifying it.
@inherits:
[class]object[/class]
[class]widget[/class]
@description:
This is a class for advanced KVIrc scripting.[br]
It can wrap any existing KVIrc widget.[br]
This class allows some unbelievable changes to the whole graphic environment of the kvirc,[br]
in fact, could hook every widget, you can modify the property or you can be inserted other widget as child of this...[br]
in short you have absolute liberty. [br]
The power of this class is fantastic, because it allows the change at "run time" of almost all the elements of the Kvirc.[br]
But to use this class in optimal way and to exploit its power, you have to know the TQt.... so you won't have limits [br]
The KVIrc TQt widgets are arranged in trees (just as the objects).[br]
The difference is that there are more toplevel widgets (and so more than one tree).[br]
You can use [fnc]$objects.dump()[/fnc] to take a look at the KVIrc TQt objects tree.[br]
Here is a part of the tree:[br][br]
Ptr 14332520: top level object: kvirc_frame, class KviFrame, visible, rect = -4, -4, 1024, 708
Ptr 17296024: object: qt_top_dock, class TQDockArea
Ptr 14882136: object: qt_custom_toolbar, class KviCustomToolBar
Ptr 18143368: object: qt_dockwidget_internal, class TQDockWindowTitleBar
[br][br]
Every listed widget has a "name", a "class" and a set of properties.[br]
The first entry in this example is a KVIrc server window, class "KviFrame" and name "kvirc_frame":
it is a toplevel widget.[br]
The "qt_top_dock", "qt_custom_toolbar" and the "qt_dockwidget_internal" are
direct children of that widget.[br]
To indicate a specific widget we will use the "class::name" form.[br]
So to indicate the main KVIrc frame you will use "KviFrame::kvirc_main_frame".
Look at this example:[br]
%A=$new(wrapper,0,test,KviFrame::kvirc_frame,KviStatusBar::unnamed)[br]
%A->$setBackGroundColor(FFFFFF)[br]
For first thing we create an object type wrapper,then we flow the tree that there from the command /object.dump and we will have:[br]
. [br]
. [br]
Ptr 14196288: top level object: kvirc_frame, class KviFrame, visible, rect = -4, -4, 1024, 712 [br]
. [br]
Ptr 17197360: object: unnamed, class KviStatusBar [br]
. [br]
. [br]
in this way we can follow the order, father->child from the top-level widget(KviFrame::kvirc_frame)[br]
to reach the child that interests us (KviStatusBar::unnamed)[br]
Then, following the syntax we will have:
%A=$new(wrapper,0,test,KviFrame::kvirc_frame,KviStatusBar::unnamed)
Now %A. will be point to the wrapped object, therefore we could modify its property or to consider it as if it were an object created by us in scripting. [br]
Obviously, deleting the created object (for example %A) you don't will delete the object of Kvirc (in this case the statusbar). [br]
Another example could be this:[br]
%A=$new(wrapper,0,test,KviFrame::kvirc_frame,TQToolButton::kvirc.identityoptions)[br]
%A->$setProperty(usesBigPixmap,0)[br]
In this fool example with the function $setProperty, we has setted the property usesBigPixmap to False, making to become the small icons of the ToolBar.[br]
[br]
The wrapping object search can optionally start with a window
identifier with the following syntax: WinId::<window_id>.
*/
KVSO_BEGIN_REGISTERCLASS(KviKvsObject_wrapper,"wrapper","widget")
KVSO_END_REGISTERCLASS(KviKvsObject_wrapper)
KVSO_BEGIN_CONSTRUCTOR(KviKvsObject_wrapper,KviKvsObject_widget)
KVSO_END_CONSTRUCTOR(KviKvsObject_wrapper)
KVSO_BEGIN_DESTRUCTOR(KviKvsObject_wrapper)
KVSO_END_CONSTRUCTOR(KviKvsObject_wrapper)
bool KviKvsObject_wrapper::init(KviKvsRunTimeContext * pContext,KviKvsVariantList *pParams)
{
if( !pParams ) return false;
debug ("ci sono i parametri");
TQWidget *pWidget = 0;
int i=0;
while(i!=pParams->count())
{
TQString szClass;
TQString szName;
TQString s=0;
pParams->at(i)->asString(s);
if (!s.isEmpty())
{
int idx = s.find("::");
if( idx != -1 ) {
szClass = s.left(idx);
szName = s.right(s.length() - idx - 2);
} else {
szClass = s;
szName = "";
}
debug ("szClass %s",szClass.latin1());
debug ("szName %s",szName.latin1());
debug ("s %s",s.latin1());
if(KviTQString::equalCI(szClass,"WinId"))
{
if(pWidget)
{
pContext->warning(__tr2qs("The window identifier preceeded by WinId must be the first object in the search path"));
return false;
} else {
pWidget = g_pApp->findWindow(szName);
}
} else {
if(pWidget) {
pWidget = findWidgetToWrap(
!szClass.isEmpty() ? szClass : KviTQString::empty, !szName.isEmpty() ? szName : KviTQString::empty, pWidget
);
} else {
pWidget = findTopLevelWidgetToWrap(szClass.isEmpty() ? szClass : KviTQString::empty, !szName.isEmpty() ? szName : KviTQString::empty);
}
}
if( !pWidget )
{
pContext->warning(__tr2qs("Failed to find one of the wrap path widgets (%Q::%Q)"),&szClass,&szName);
return false;
}
}
i++;
}
if( !pWidget )
{
pContext->warning(__tr2qs("Failed to find the widget to wrap"));
return false;
}
setObject(TQT_TQOBJECT(pWidget),false);
return true;
}
TQWidget *KviKvsObject_wrapper::findTopLevelWidgetToWrap(const TQString szClass, const TQString szName)
{
#ifdef COMPILE_USE_QT4
TQWidgetList list = g_pApp->topLevelWidgets();
if( !list.count() ) return 0;
for(int idx=0;idx<list.count();idx++)
{
bool bNameMatch = false;
bool bClassMatch = false;
if( !szName.isEmpty() )
bNameMatch = KviTQString::equalCI(list.at(idx)->name(), szName);
else
bNameMatch = true;
if( !szClass.isEmpty())
bClassMatch = KviTQString::equalCI(list.at(idx)->className(), szClass);
else
bClassMatch = true;
if( bNameMatch && bClassMatch ) {
TQWidget *w = list.at(idx);
return w;
}
}
return 0;
#else
TQWidgetList *list = g_pApp->topLevelWidgets();
if( !list ) return 0;
TQWidgetListIt it(*list);
while( it.current() ) {
bool bNameMatch = false;
bool bClassMatch = false;
if( szName )
bNameMatch = KviTQString::equalCI(it.current()->name(), szName);
else
bNameMatch = true;
if( szClass )
bClassMatch = KviTQString::equalCI(it.current()->className(), szClass);
else
bClassMatch = true;
if( bNameMatch && bClassMatch ) {
TQWidget *w = it.current();
delete list;
return w;
}
++it;
}
delete list;
return 0;
#endif
}
TQWidget *KviKvsObject_wrapper::findWidgetToWrap(const char *szClass, const char *szName, TQWidget *childOf)
{
#ifdef COMPILE_USE_QT4
TQObjectList list = childOf->queryList(szClass ? szClass : 0, szName ? szName : 0, false, true);
if( !list.count() ) return 0;
for(int idx=0;idx<list.count();idx++)
{
if( list.at(idx)->isWidgetType() ) {
TQWidget *w = (TQWidget *)list.at(idx);
return w;
}
}
return 0;
#else
TQObjectList *list = childOf->queryList(szClass ? szClass : 0, szName ? szName : 0, false, true);
if( !list ) return 0;
TQObjectListIt it(*list);
while( it.current() ) {
if( it.current()->isWidgetType() ) {
TQWidget *w = (TQWidget *) it.current();
delete list;
return w;
}
++it;
}
delete list;
return 0;
#endif
}
#include "m_class_wrapper.moc"