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

372 lines
12 KiB

//mdm:
// File : class_wizard.cpp
// Creation date : Mon Apr 10 19: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 <kvi_tal_wizard.h>
#include <tqpushbutton.h>
#include "class_wizard.h"
#include "kvi_error.h"
#include "kvi_debug.h"
#include "kvi_locale.h"
/*
@doc: wizard
@keyterms:
wizard object class,
@title:
wizard class
@type:
class
@short:
The wizard class provides a framework for wizard dialogs.
@inherits:
[class]object[/class]
[class]widget[/class]
@description:
A wizard is an input dialog that consists of a sequence of dialog pages.It walks the user through a process step by step.[br]
@functions:
!fn: $addPage(<page_widget:object>,<title:string>)
Add a page with title.<page_widget> must be a widget's object.
!fn: $insertPage(<page_widget>,<title:string>,<index:integer>)
Inserts a page at the position <index>. If index is -1, page will appended to the end of the wizard's page sequenze.
!fn: $setTitle(<page>,<title:string>)
Sets the title for page page to title text.
!fn: $setBackEnabled(<page_widget>,<bEnabled:boolean>)
If enable is set to 1, page page has a Back button; otherwise page has no Back button.[br]
By default all pages have this button.
!fn: $setNextEnabled(<page_widget>,<bEnabled:boolean>)
If enable is set to 1, page page has a Next button; otherwise the Next button on page is disabled.[br]
By default all pages have this button.
!fn: $setFinishEnabled(<page_widget>,<bEnabled:boolean>)
If enable is set to 1, page page has a Finish button; otherwise the Finish button on page is disabled.[br]
By default NO pages have this button.
!fn: $setHelpEnabled(<page_widget>,<bEnabled:boolean>)
If enable is set to 1, page page has a Help button; otherwise the Help button on page is disabled.[br]
By default all pages have this button.
!fn: $setNextBtnText(<text:string>)
Set the text for button Next.
!fn: $setBackBtnText(<text:string>)
Set the text for button Back.
!fn: $setFinishBtnText(<text:string>)
Set the text for button Finish.
!fn: $setHelpBtnText(<text:string>)
Set the text for button Help.
!fn: $acceptEvent()
This function is called when the user click on the Finish button.
!fn: $rejectEvent()
This function is called when thie user click on the Reject button.
!fn: $nextClickedEvent()
This function is called when the user click on the Next button.
!fn: $backClickedEvent()
This function is called when thie user click on the Back button.
@signals:
!sg: $nextClicked()
This signal is emitted by the default implementation of [classfnc]$nextClickedEvent[/classfnc]().
!sg: $backClicked()
This signal is emitted by the default implementation of [classfnc]$backClickedEvent[/classfnc]().
*/
KVSO_BEGIN_REGISTERCLASS(KviKvsObject_wizard,"wizard","widget")
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"addPage", functionaddPage)
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"insertPage", functioninsertPage)
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setTitle", functionsetTitle)
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setBackEnabled", functionsetBackEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setNextEnabled", functionsetNextEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setFinishEnabled", functionsetFinishEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setHelpEnabled", functionsetHelpEnabled);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setBackBtnText", functionsetBackBtnText);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setNextBtnText", functionsetNextBtnText);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setFinishBtnText", functionsetFinishBtnText);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"setHelpBtnText", functionsetHelpBtnText);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"nextClickedEvent", functionnextClickedEvent);
KVSO_REGISTER_HANDLER(KviKvsObject_wizard,"backClickedEvent", functionbackClickedEvent);
KVSO_REGISTER_STANDARD_NOTHINGRETURN_HANDLER(KviKvsObject_wizard,"acceptEvent")
KVSO_REGISTER_STANDARD_NOTHINGRETURN_HANDLER(KviKvsObject_wizard,"rejectEvent")
KVSO_END_REGISTERCLASS(KviKvsObject_wizard)
KVSO_BEGIN_CONSTRUCTOR(KviKvsObject_wizard,KviKvsObject_widget)
KVSO_END_CONSTRUCTOR(KviKvsObject_wizard)
KVSO_BEGIN_DESTRUCTOR(KviKvsObject_wizard)
KVSO_END_CONSTRUCTOR(KviKvsObject_wizard)
bool KviKvsObject_wizard::init(KviKvsRunTimeContext * pContext,KviKvsVariantList *pParams)
{
setObject(TQT_TQOBJECT(new KviKvsMdmWizard(parentScriptWidget(), name(),this)), true);
return true;
}
bool KviKvsObject_wizard::functionaddPage(KviKvsObjectFunctionCall *c)
{
KviKvsObject *ob;
TQString szLabel;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("label",KVS_PT_STRING,0,szLabel)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Can't add a non-widget object"));
return true;
}
((KviTalWizard *)widget())->addPage(((TQWidget *)(ob->object())),szLabel);
return true;
}
bool KviKvsObject_wizard::functioninsertPage(KviKvsObjectFunctionCall *c)
{
KviKvsObject *ob;
TQString szLabel;
kvs_int_t uIndex;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("label",KVS_PT_STRING,0,szLabel)
KVSO_PARAMETER("index",KVS_PT_UNSIGNEDINTEGER,0,uIndex)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Can't add a non-widget object"));
return true;
}
((KviTalWizard *)widget())->insertPage(((TQWidget *)(ob->object())),szLabel,uIndex);
return true;
}
bool KviKvsObject_wizard::functionsetTitle(KviKvsObjectFunctionCall *c)
{
KviKvsObject *ob;
TQString szTitle;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("title",KVS_PT_STRING,0,szTitle)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Widget object required"));
return true;
}
((KviTalWizard *)widget())->setPageTitle(((TQWidget *)(ob->object())),szTitle);
return true;
}
bool KviKvsObject_wizard::functionsetBackEnabled(KviKvsObjectFunctionCall *c)
{
bool bEnabled;
KviKvsObject *ob;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Widget object required"));
return true;
}
((KviTalWizard *)widget())->setBackEnabled(((TQWidget *)(ob->object())),bEnabled);
return true;
}
bool KviKvsObject_wizard::functionsetNextEnabled(KviKvsObjectFunctionCall *c)
{
bool bEnabled;
KviKvsObject *ob;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Widget object required"));
return true;
}
((KviTalWizard *)widget())->setNextEnabled(((TQWidget *)(ob->object())),bEnabled);
return true;
}
bool KviKvsObject_wizard::functionsetFinishEnabled(KviKvsObjectFunctionCall *c)
{
bool bEnabled;
KviKvsObject *ob;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Widget object required"));
return true;
}
((KviTalWizard *)widget())->setFinishEnabled(((TQWidget *)(ob->object())),bEnabled);
return true;
}
bool KviKvsObject_wizard::functionsetHelpEnabled(KviKvsObjectFunctionCall *c)
{
bool bEnabled;
KviKvsObject *ob;
kvs_hobject_t hObject;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("page_widget",KVS_PT_HOBJECT,0,hObject)
KVSO_PARAMETER("bEnabled",KVS_PT_BOOL,0,bEnabled)
KVSO_PARAMETERS_END(c)
ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
if(!widget())return true;
if(!ob->object()->isWidgetType())
{
c->warning(__tr2qs("Widget object required"));
return true;
}
((KviTalWizard *)widget())->setHelpEnabled(((TQWidget *)(ob->object())),bEnabled);
return true;
}
bool KviKvsObject_wizard::functionsetBackBtnText(KviKvsObjectFunctionCall *c)
{
TQString szText;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("text",KVS_PT_STRING,0,szText)
KVSO_PARAMETERS_END(c)
if (widget())
((KviTalWizard *)widget())->KviTalWizard::backButton()->setText(szText);
return true;
}
bool KviKvsObject_wizard::functionsetNextBtnText(KviKvsObjectFunctionCall *c)
{
TQString szText;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("text",KVS_PT_STRING,0,szText)
KVSO_PARAMETERS_END(c)
if (widget())
((KviTalWizard *)widget())->KviTalWizard::nextButton()->setText(szText);
return true;
}
bool KviKvsObject_wizard::functionsetHelpBtnText(KviKvsObjectFunctionCall *c)
{
TQString szText;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("text",KVS_PT_STRING,0,szText)
KVSO_PARAMETERS_END(c)
if (widget())
((KviTalWizard *)widget())->KviTalWizard::helpButton()->setText(szText);
return true;
}
bool KviKvsObject_wizard::functionsetFinishBtnText(KviKvsObjectFunctionCall *c)
{
TQString szText;
KVSO_PARAMETERS_BEGIN(c)
KVSO_PARAMETER("text",KVS_PT_STRING,0,szText)
KVSO_PARAMETERS_END(c)
if (widget())
((KviTalWizard *)widget())->KviTalWizard::finishButton()->setText(szText);
return true;
}
bool KviKvsObject_wizard::accept()
{
KviKvsVariantList * pParams = 0;
callFunction(this,"acceptEvent",0,pParams);
return true;
}
bool KviKvsObject_wizard::reject()
{
KviKvsVariantList * pParams = 0;
callFunction(this,"rejectEvent",0,pParams);
return true;
}
bool KviKvsObject_wizard::functionnextClickedEvent(KviKvsObjectFunctionCall *c)
{
emitSignal("nextClicked",c);
return true;
}
void KviKvsObject_wizard::nextClicked()
{
KviKvsVariantList *params=0;
callFunction(this,"nextClickedEvent",params);
}
bool KviKvsObject_wizard::functionbackClickedEvent(KviKvsObjectFunctionCall *c)
{
emitSignal("backClicked",c);
return true;
}
void KviKvsObject_wizard::backClicked()
{
KviKvsVariantList *params=0;
callFunction(this,"backClickedEvent",params);
}
KviKvsMdmWizard::KviKvsMdmWizard(TQWidget * par,const char * name,KviKvsObject_wizard * tqparent)
:KviTalWizard(par)
{
m_pParentScript=tqparent;
connect (this->backButton(),TQT_SIGNAL(clicked()),this,TQT_SLOT(slotBackClicked()));
connect (this->nextButton(),TQT_SIGNAL(clicked()),this,TQT_SLOT(slotNextClicked()));
}
void KviKvsMdmWizard::accept()
{
if(m_pParentScript->accept())KviTalWizard::accept();
}
void KviKvsMdmWizard::reject()
{
if(m_pParentScript->reject())KviTalWizard::reject();
}
void KviKvsMdmWizard::slotNextClicked()
{
m_pParentScript->nextClicked();
}
void KviKvsMdmWizard::slotBackClicked()
{
m_pParentScript->backClicked();
}
KviKvsMdmWizard::~KviKvsMdmWizard()
{
}
#include "m_class_wizard.moc"