• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KIO

Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KPropertiesDialogPlugin Class Reference

#include <kpropertiesdialog.h>

Inheritance diagram for KPropertiesDialogPlugin:
QObject KDEPrivate::KDesktopPropsPlugin KDEPrivate::KDevicePropsPlugin KDEPrivate::KFilePermissionsPropsPlugin KDEPrivate::KFilePropsPlugin KDEPrivate::KUrlPropsPlugin KFileMetaPropsPlugin KFileSharePropsPlugin KPreviewPropsPlugin

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::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 613 of file kpropertiesdialog.cpp.

◆ ~KPropertiesDialogPlugin()

KPropertiesDialogPlugin::~KPropertiesDialogPlugin ( )
virtual

Definition at line 621 of file kpropertiesdialog.cpp.

Member Function Documentation

◆ applyChanges()

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 648 of file kpropertiesdialog.cpp.

◆ changed

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.

◆ fontHeight()

int KPropertiesDialogPlugin::fontHeight ( ) const
protected

Returns the font height.

Definition at line 653 of file kpropertiesdialog.cpp.

◆ isDesktopFile()

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 627 of file kpropertiesdialog.cpp.

◆ isDirty()

bool KPropertiesDialogPlugin::isDirty ( ) const

Definition at line 643 of file kpropertiesdialog.cpp.

◆ setDirty [1/2]

void KPropertiesDialogPlugin::setDirty ( )
slot

Definition at line 638 of file kpropertiesdialog.cpp.

◆ setDirty() [2/2]

void KPropertiesDialogPlugin::setDirty ( bool  b)

Definition at line 633 of file kpropertiesdialog.cpp.

Member Data Documentation

◆ properties

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal