Source: ktexteditor/configinterfaceextension.h
|
|
|
|
/* This file is part of the KDE libraries
Copyright (C) 2001 Christoph Cullmann
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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __ktexteditor_configinterfaceextension_h__
#define __ktexteditor_configinterfaceextension_h__
#include
#include
#include
namespace KTextEditor
{
class ConfigPage : public QWidget
{
Q_OBJECT
public:
ConfigPage ( QWidget *parent=0, const char *name=0 );
virtual ~ConfigPage ();
//
// slots !!!
//
public:
/**
Applies the changes to the document
*/
virtual void apply () = 0;
/**
Reset the changes
*/
virtual void reset () = 0;
/**
Sets default options
*/
virtual void defaults () = 0;
};
/*
* This is an interface for the KTextEditor::Document/Plugin/ViewPlugin classes !!!
*/
class ConfigInterfaceExtension
{
friend class PrivateConfigInterfaceExtension;
public:
ConfigInterfaceExtension();
virtual ~ConfigInterfaceExtension();
unsigned int configInterfaceExtensionNumber () const;
protected:
void setConfigInterfaceExtensionDCOPSuffix (const QCString &suffix);
//
// slots !!!
//
public:
/**
Number of available config pages
*/
virtual uint configPages () const = 0;
/**
returns config page with the given number,
config pages from 0 to configPages()-1 are available
if configPages() > 0
*/
virtual ConfigPage *configPage (uint number = 0, QWidget *parent = 0, const char *name=0 ) = 0;
virtual QString configPageName (uint number = 0) const = 0;
virtual QString configPageFullName (uint number = 0) const = 0;
virtual QPixmap configPagePixmap (uint number = 0, int size = KIcon::SizeSmall) const = 0;
private:
class PrivateConfigInterfaceExtension *d;
static unsigned int globalConfigInterfaceExtensionNumber;
unsigned int myConfigInterfaceExtensionNumber;
};
class Document;
class Plugin;
class ViewPlugin;
ConfigInterfaceExtension *configInterfaceExtension (Document *doc);
ConfigInterfaceExtension *configInterfaceExtension (Plugin *plugin);
};
#endif
Generated by: caleb on tcdevel on Tue Jan 28 12:54:37 2003, using kdoc $. |