.TH "KPropsDlgPlugin" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KPropsDlgPlugin \- A Plugin in the Properties dialog This is an abstract class.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kpropertiesdialog.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
Inherited by \fBKApplicationPropsPlugin\fP, \fBKBindingPropsPlugin\fP, \fBKDevicePropsPlugin\fP, \fBKExecPropsPlugin\fP, \fBKFileMetaPropsPlugin\fP, \fBKFilePermissionsPropsPlugin\fP, \fBKFilePropsPlugin\fP, \fBKFileSharePropsPlugin\fP, and \fBKURLPropsPlugin\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBsetDirty\fP ()"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBchanged\fP ()"
.br
.RI "\fIEmit this signal when the user changed anything in the plugin's tabs. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKPropsDlgPlugin\fP (\fBKPropertiesDialog\fP *_props)"
.br
.RI "\fIConstructor To insert tabs into the properties dialog, use the add methods provided by \fBKDialogBase\fP (the properties dialog is a \fBKDialogBase\fP). \fP"
.ti -1c
.RI "virtual void \fBapplyChanges\fP ()"
.br
.RI "\fIApplies all changes to the file. \fP"
.ti -1c
.RI "void \fBsetDirty\fP (bool b)"
.br
.ti -1c
.RI "bool \fBisDirty\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBisDesktopFile\fP (\fBKFileItem\fP *_item)"
.br
.RI "\fIConvenience method for most ::supports methods. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBKPropertiesDialog\fP * \fBproperties\fP"
.br
.RI "\fIPointer to the dialog. \fP"
.ti -1c
.RI "int \fBfontHeight\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A Plugin in the Properties dialog This is an abstract class. 

You must inherit from this class to build a new kind of page. 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.
.PP
To make a plugin available, define a service that implements the KPropsDlg/Plugin servicetype, as well as the mimetypes for which the plugin should be created. For instance, ServiceTypes=KPropsDlg/Plugin,text/html,application/x-mymimetype.
.PP
You can also include X-KDE-Protocol=file if you want that plugin to be loaded only for local files, for instance. 
.PP
Definition at line 334 of file kpropertiesdialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KPropsDlgPlugin::KPropsDlgPlugin (\fBKPropertiesDialog\fP * _props)"
.PP
Constructor To insert tabs into the properties dialog, use the add methods provided by \fBKDialogBase\fP (the properties dialog is a \fBKDialogBase\fP). Definition at line 535 of file kpropertiesdialog.cpp.
.PP
References KPropertiesDialog::dialog(), and properties.
.SH "Member Function Documentation"
.PP 
.SS "void KPropsDlgPlugin::applyChanges ()\fC [virtual]\fP"
.PP
Applies all changes to the file. This function is called when the user presses 'Ok'. The last plugin inserted is called first. Reimplemented in \fBKFileSharePropsPlugin\fP, \fBKFileMetaPropsPlugin\fP, \fBKFilePropsPlugin\fP, \fBKFilePermissionsPropsPlugin\fP, \fBKExecPropsPlugin\fP, \fBKURLPropsPlugin\fP, \fBKApplicationPropsPlugin\fP, \fBKBindingPropsPlugin\fP, and \fBKDevicePropsPlugin\fP.
.PP
Definition at line 586 of file kpropertiesdialog.cpp.
.PP
Referenced by KPropertiesDialog::slotOk().
.SS "bool KPropsDlgPlugin::isDesktopFile (\fBKFileItem\fP * _item)\fC [static]\fP"
.PP
Convenience method for most ::supports methods. \fBReturns:\fP
.RS 4
true if the file is a local, regular, readable, desktop file 
.RE
.PP
Definition at line 549 of file kpropertiesdialog.cpp.
.PP
References QFile::encodeName(), QString::fromLatin1(), KFileItem::isLocalFile(), KFileItem::mimetype(), KFileItem::mode(), KURL::path(), and KFileItem::url().
.PP
Referenced by KFilePropsPlugin::KFilePropsPlugin().
.SS "void KPropsDlgPlugin::changed ()\fC [signal]\fP"
.PP
Emit this signal when the user changed anything in the plugin's tabs. The hosting PropertiesDialog will call \fBapplyChanges\fP only if the PropsPlugin has emitted this signal before. Referenced by KApplicationPropsPlugin::KApplicationPropsPlugin(), KBindingPropsPlugin::KBindingPropsPlugin(), KExecPropsPlugin::KExecPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), KFilePropsPlugin::KFilePropsPlugin(), and KURLPropsPlugin::KURLPropsPlugin().
.SH "Member Data Documentation"
.PP 
.SS "\fBKPropertiesDialog\fP* \fBKPropsDlgPlugin::properties\fP\fC [protected]\fP"
.PP
Pointer to the dialog. Definition at line 377 of file kpropertiesdialog.h.
.PP
Referenced by KDevicePropsPlugin::applyChanges(), KBindingPropsPlugin::applyChanges(), KApplicationPropsPlugin::applyChanges(), KURLPropsPlugin::applyChanges(), KExecPropsPlugin::applyChanges(), KFilePermissionsPropsPlugin::applyChanges(), KFilePropsPlugin::applyChanges(), KFileSharePropsPlugin::applyChanges(), KApplicationPropsPlugin::KApplicationPropsPlugin(), KBindingPropsPlugin::KBindingPropsPlugin(), KExecPropsPlugin::KExecPropsPlugin(), KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), KFilePropsPlugin::KFilePropsPlugin(), KPropsDlgPlugin(), KURLPropsPlugin::KURLPropsPlugin(), and KFilePropsPlugin::postApplyChanges().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
