KPropertiesDialogPlugin Class Reference

A Plugin in the Properties dialog This is an abstract class. More...

#include <kpropertiesdialog.h>

Inheritance diagram for KPropertiesDialogPlugin:

List of all members.

Public Slots
void	setDirty ()
Signals
void	changed ()
Public Member Functions
	KPropertiesDialogPlugin (KPropertiesDialog *_props)
virtual	~KPropertiesDialogPlugin ()
virtual void	applyChanges ()
bool	isDirty () const
void	setDirty (bool b)
Static Public Member Functions
static bool	isDesktopFile (const KFileItem &_item)
Protected Member Functions
int	fontHeight () const
Protected Attributes
KPropertiesDialog *	properties

---

Detailed Description

A Plugin in the Properties dialog This is an abstract class.

You must inherit from this class to build a new kind of tabbed page for the KPropertiesDialog. A plugin in itself is just a library containing code, not a dialog's page. It's up to the plugin to insert pages into the parent dialog.

To make a plugin available, define a service that implements the KPropertiesDialog/Plugin servicetype, as well as the mimetypes for which the plugin should be created. For instance, ServiceTypes=KPropertiesDialog/Plugin,text/html,application/x-mymimetype.

You can also include X-KDE-Protocol=file if you want that plugin to be loaded only for local files, for instance.

Definition at line 347 of file kpropertiesdialog.h.

---

Constructor & Destructor Documentation

KPropertiesDialogPlugin::KPropertiesDialogPlugin

(

KPropertiesDialog *

_props

)

Constructor To insert tabs into the properties dialog, use the add methods provided by KPageDialog (the properties dialog is a KPageDialog).

Definition at line 630 of file kpropertiesdialog.cpp.

KPropertiesDialogPlugin::~KPropertiesDialogPlugin

(

)

[virtual]

Definition at line 638 of file kpropertiesdialog.cpp.

---

Member Function Documentation

void KPropertiesDialogPlugin::applyChanges

(

)

[virtual]

Applies all changes to the file.

This function is called when the user presses 'Ok'. The last plugin inserted is called first.

Reimplemented in KFileSharePropsPlugin, KFileMetaPropsPlugin, KDEPrivate::KFilePropsPlugin, KDEPrivate::KFilePermissionsPropsPlugin, KDEPrivate::KUrlPropsPlugin, KDEPrivate::KDevicePropsPlugin, and KDEPrivate::KDesktopPropsPlugin.

Definition at line 665 of file kpropertiesdialog.cpp.

void KPropertiesDialogPlugin::changed

(

)

[signal]

Emit this signal when the user changed anything in the plugin's tabs.

The hosting PropertiesDialog will call applyChanges only if the PropsPlugin has emitted this signal or if you have called setDirty() before.

int KPropertiesDialogPlugin::fontHeight

(

)

const [protected]

Returns the font height.

Definition at line 670 of file kpropertiesdialog.cpp.

bool KPropertiesDialogPlugin::isDesktopFile

(

const KFileItem &

_item

)

[static]

Convenience method for most ::supports methods.

Returns:

true if the file is a local, regular, readable, desktop file

Deprecated:

use KFileItem::isDesktopFile

Definition at line 644 of file kpropertiesdialog.cpp.

bool KPropertiesDialogPlugin::isDirty

(

)

const

Definition at line 660 of file kpropertiesdialog.cpp.

void KPropertiesDialogPlugin::setDirty

(

bool

b

)

Definition at line 650 of file kpropertiesdialog.cpp.

void KPropertiesDialogPlugin::setDirty

(

)

[slot]

Definition at line 655 of file kpropertiesdialog.cpp.

---

Member Data Documentation

KPropertiesDialog* KPropertiesDialogPlugin::properties [protected]

Pointer to the dialog.

Definition at line 393 of file kpropertiesdialog.h.

---

The documentation for this class was generated from the following files:

• kpropertiesdialog.h
• kpropertiesdialog.cpp