• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • TDevelop Interfaces Library
 

TDevelop Interfaces Library

Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KDevPluginController Class Referenceabstract

#include <kdevplugincontroller.h>

Inherits TQObject.

Signals

void profileChanged ()
 

Public Member Functions

virtual KDevPlugin * loadPlugin (const TQString &serviceType, const TQString &constraint)=0
 
virtual void unloadPlugin (const TQString &plugin)=0
 
virtual void unloadPlugins (TQStringList const &list)=0
 
virtual const TQValueList< KDevPlugin * > loadedPlugins ()=0
 
virtual KDevPlugin * extension (const TQString &serviceType, const TQString &constraint="")=0
 
virtual KURL::List profileResources (const TQString &nameFilter)
 
virtual KURL::List profileResourcesRecursive (const TQString &nameFilter)
 
virtual ProfileEngine & engine ()=0
 

Static Public Member Functions

static TDETrader::OfferList query (const TQString &serviceType, const TQString &constraint)
 
static TDETrader::OfferList queryPlugins (const TQString &constraint)
 

Protected Member Functions

 KDevPluginController ()
 

Detailed Description

The base class for TDevelop plugin controller.

Plugin controller is responsible for quering, loading and unloading available plugins.

Definition at line 39 of file kdevplugincontroller.h.

Constructor & Destructor Documentation

◆ KDevPluginController()

KDevPluginController::KDevPluginController ( )
protected

Constructor.

Definition at line 23 of file kdevplugincontroller.cpp.

Member Function Documentation

◆ engine()

virtual ProfileEngine& KDevPluginController::engine ( )
pure virtual
Returns
The current Profile Engine

◆ extension()

virtual KDevPlugin* KDevPluginController::extension ( const TQString &  serviceType,
const TQString &  constraint = "" 
)
pure virtual

Queries for the plugin which supports given service type.

All already loaded plugins will be queried and the first one to support the service type will be returned. Any plugin can be an extension, only "X-TDE-ServiceTypes=..." entry is required in .desktop file for that plugin.

Parameters
serviceTypeThe service type of an extension (like "TDevelop/SourceFormatter")
constraintThe constraint which is applied when quering for the service. This constraint is a usual TDETrader constraint statement (like "[X-TDevelop-Foo]=='MyFoo'").
Returns
A KDevelop extension plugin for given service type or 0 if no plugin supports it

◆ loadedPlugins()

virtual const TQValueList<KDevPlugin*> KDevPluginController::loadedPlugins ( )
pure virtual
Returns
The list of currently loaded plugins.

◆ loadPlugin()

virtual KDevPlugin* KDevPluginController::loadPlugin ( const TQString &  serviceType,
const TQString &  constraint 
)
pure virtual

Returns a uniquely specified plugin.

If it isn't already loaded, it will be. Use with caution! See extension for parameter details.

◆ profileChanged

void KDevPluginController::profileChanged ( )
signal

Emitted when a plugin profile was changed (reloaded, other profile opened, etc.).

Should work only on shells with plugin profiles support.

◆ profileResources()

KURL::List KDevPluginController::profileResources ( const TQString &  nameFilter)
virtual

Reimplement this function only if your shell supports plugin profiles.

Returns
The list of URLs to the profile resources (files) with given extension.
Parameters
nameFilterName filter for files.
See also
TQDir::setNameFilter documentation for name filters syntax.

Definition at line 39 of file kdevplugincontroller.cpp.

◆ profileResourcesRecursive()

KURL::List KDevPluginController::profileResourcesRecursive ( const TQString &  nameFilter)
virtual

Reimplement this function only if your shell supports plugin profiles.

Returns
The list of URLs to the resources (files) with given extension. This list is obtained by a recursive search that process given profile and all it's subprofiles.
Parameters
nameFilterName filter for files.
See also
TQDir::setNameFilter documentation for name filters syntax.

Definition at line 44 of file kdevplugincontroller.cpp.

◆ query()

TDETrader::OfferList KDevPluginController::query ( const TQString &  serviceType,
const TQString &  constraint 
)
static

Queries KDevelop services.

Version is checked automatically by adding proper X-TDevelop-Version=N statement into the query.

Parameters
serviceTypeThe service type to query, for example "TDevelop/Plugin" or "TDevelop/SourceFormatter."
constraintA constraint for the service. Do not include plugin version number - it is done automatically.
Returns
The list of plugin offers.

Definition at line 27 of file kdevplugincontroller.cpp.

◆ queryPlugins()

TDETrader::OfferList KDevPluginController::queryPlugins ( const TQString &  constraint)
static

Queries TDevelop plugins.

Works like KDevPluginController::query with serviceType set to "TDevelop/Plugin".

Parameters
constraintA constraint for the service. Do not include plugin version number - it is done automatically.
Returns
The list of plugin offers.

Definition at line 34 of file kdevplugincontroller.cpp.

◆ unloadPlugin()

virtual void KDevPluginController::unloadPlugin ( const TQString &  plugin)
pure virtual

Unloads the plugin specified by plugin.

Parameters
pluginThe plugin desktopEntryName of the plugin to unload

◆ unloadPlugins()

virtual void KDevPluginController::unloadPlugins ( TQStringList const &  list)
pure virtual

Unloads plugins specified by list.

Parameters
listThe list of plugin names to unload. plugin name corresponds to the "Name" property in plugin .desktop file.

The documentation for this class was generated from the following files:
  • kdevplugincontroller.h
  • kdevplugincontroller.cpp

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for TDevelop Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.