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.
tdenetwork/kopete/libkopete/kcautoconfigmodule.h

152 lines
4.7 KiB

/* This file is part of the KDE project
Copyright (C) 2003 Olivier Goffart <ogoffart @ kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KCAUTOCONFIGMODULE_H
#define KCAUTOCONFIGMODULE_H
#include <tdecmodule.h>
#include "kopete_export.h"
class KAutoConfig;
class TDEConfig;
/**
* @short Convenience TDECModule for creating config page handled with KAutoConfig
*
* This class makes it very easy to create a configuration page using KAutoConfig.
* All you need to do is create a class that is derived from KCAutoConfigModule, create your
* config page with TQDesigner, and add it to the module
* This can be done using the setMainWidget() method:
* \code
* typedef KGenericFactory<MyPageConfig, TQWidget> MyPageConfigFactory;
* K_EXPORT_COMPONENT_FACTORY( kcm_mypageconfig, MyPageConfigFactory( "kcm_mypageconfig" ) )
*
* MyPageConfig( TQWidget * parent, const char *, const TQStringList & args )
* : KCAutoConfigModule( MyPageConfigFactory::instance(), parent, args )
* {
* setMainWidget( new MyPageConfigBase(this) , "MyGroup" );
* }
* \endcode
*
*
* @author Olivier Goffart <ogoffart(@)tisclinet.be>
* @since 3.2
*/
class KOPETE_EXPORT KCAutoConfigModule : public TDECModule
{
TQ_OBJECT
public:
/**
* Standard TDECModule constructor. Use TDEGlobal::config()
*/
KCAutoConfigModule( TQWidget * parent = 0, const char * name = 0, const TQStringList & args = TQStringList() );
/**
* Standard TDECModule constructor. Use TDEGlobal::config()
*/
KCAutoConfigModule( TDEInstance * instance, TQWidget * parent = 0, const TQStringList & args = TQStringList() );
/**
* Constructor.
* @param config the TDEConfig to use
* @param instance TDEInstance object for this KCM
* @param parent parent widget
* @param args special arguments for this KCM
*
* @todo document what the args mean (inherited from TDECModule?)
*/
KCAutoConfigModule(TDEConfig* config, TDEInstance * instance, TQWidget * parent = 0, const TQStringList & args = TQStringList() );
/**
* Constructor, much like the one above, except with
* no instance and with a name.
* @param config the TDEConfig to use
* @param parent parent widget
* @param name name of the object
* @param args special arguments for this KCM
*/
KCAutoConfigModule(TDEConfig* config, TQWidget * parent = 0, const char * name=0 , const TQStringList & args = TQStringList() );
~KCAutoConfigModule();
/**
* Set the main widget. @p widget will be lay out to take all available place in the module.
* @p widget must have this module as parent.
*
* This method automatically call KAutoConfig::addWidget() and KAutoConfig::retrieveSettings()
*
* @param widget the widget to place on the page and to add in the KAutoConfig
* @param group the name of the group where settings are stored in the config file
*/
void setMainWidget(TQWidget *widget, const TQString& group);
/**
* @brief a reference to the KAutoConfig
*
* You can add or remove manually some widget from the KAutoWidget.
* If you choose to don't add the main widget with setMainWidget() , you need
* to call KAutoConfig::retrieveSettings(true) yourself
*
* @return a reference to the KAutoConfig
*/
KAutoConfig *autoConfig();
/**
* Reload the config from the configfile.
*
* You can also reimplement this method, but you should always call the parent TDECModule::load()
* be sure you know what you are doing
*/
virtual void load();
/**
* Save the config to the configfile.
*
* You can also reimplement this method, but you should always call the parent TDECModule::save()
* be sure you know what you are doing
*/
virtual void save();
/**
* Reload the default config
*
* You can also reimplement this method, but you should always call the parent TDECModule::defaults()
* be sure you know what you are doing
*/
virtual void defaults();
protected slots:
/**
* Some setting was modified, updates buttons
*/
virtual void slotWidgetModified();
private:
class KCAutoConfigModulePrivate;
KCAutoConfigModulePrivate * d;
};
#endif