KParts::FileInfoExtension

Search for usage in LXR

KParts::FileInfoExtension Class Referenceabstract

#include <KParts/FileInfoExtension>

Inheritance diagram for KParts::FileInfoExtension:

Public Types

enum  QueryMode { None = 0x00 , AllItems = 0x01 , SelectedItems = 0x02 }
 
typedef QFlags< QueryModeQueryModes
 
- Public Types inherited from QObject
typedef  QObjectList
 

Public Member Functions

 FileInfoExtension (KParts::ReadOnlyPart *parent)
 
 ~FileInfoExtension () override
 
virtual bool hasSelection () const
 
virtual KFileItemList queryFor (QueryMode mode) const =0
 
virtual QueryModes supportedQueryModes () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static FileInfoExtensionchildObject (QObject *obj)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

An extension for obtaining file information from the part.

This extension provides information about file and directory resources that are present in the part the implements it.

The main purpose of for this extension is to provide information about files and directories located on remote servers so that download managers such as kget can easily retrieve these resources.

Since
4.6

Definition at line 38 of file fileinfoextension.h.

Member Typedef Documentation

◆ QueryModes

Stores a combination of QueryMode values.

Definition at line 56 of file fileinfoextension.h.

Member Enumeration Documentation

◆ QueryMode

Supported file information retrieval modes.

See also
QueryModes
Enumerator
None 

Querying for file information is NOT possible

AllItems 

Retrieve or can retrieve file information for all items.

SelectedItems 

Retrieve or can retrieve file information for selected items.

Definition at line 47 of file fileinfoextension.h.

Constructor & Destructor Documentation

◆ FileInfoExtension()

KParts::FileInfoExtension::FileInfoExtension ( KParts::ReadOnlyPart * parent)
explicit

Constructor

Definition at line 16 of file fileinfoextension.cpp.

◆ ~FileInfoExtension()

KParts::FileInfoExtension::~FileInfoExtension ( )
override

Destructor

Definition at line 23 of file fileinfoextension.cpp.

Member Function Documentation

◆ childObject()

KParts::FileInfoExtension * KParts::FileInfoExtension::childObject ( QObject * obj)
static

Queries obj for a child object which inherits from this class.

Definition at line 27 of file fileinfoextension.cpp.

◆ hasSelection()

bool KParts::FileInfoExtension::hasSelection ( ) const
virtual

Returns true if any of the items in the current view of the part that implements this extension are selected.

By default this function returns false.

Definition at line 37 of file fileinfoextension.cpp.

◆ queryFor()

virtual KFileItemList KParts::FileInfoExtension::queryFor ( QueryMode mode) const
pure virtual

Returns a information for files that match the specified query mode.

If the mode specified by mode is not supported or cannot be handled, then an empty list is returned.

◆ supportedQueryModes()

KParts::FileInfoExtension::QueryModes KParts::FileInfoExtension::supportedQueryModes ( ) const
virtual

Returns the file information retrieve modes supported by the part that implements this extension.

By default this function returns None.

Definition at line 32 of file fileinfoextension.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 13 2024 11:50:38 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.