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

KTextEditor

  • KTextEditor
  • Factory
Public Member Functions | List of all members
KTextEditor::Factory Class Referenceabstract

#include <factory.h>

Inheritance diagram for KTextEditor::Factory:
KParts::Factory KPluginFactory QObject

Public Member Functions

 Factory (QObject *parent)
 
virtual ~Factory ()
 
virtual Editor * editor ()=0
 
- Public Member Functions inherited from KParts::Factory
 Factory (QObject *parent=0)
 
virtual ~Factory ()
 
Part * createPart (QWidget *parentWidget=0, QObject *parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())
 
virtual KComponentData partComponentData ()
 
- Public Member Functions inherited from KPluginFactory
 KPluginFactory (const char *componentName=0, const char *catalogName=0, QObject *parent=0)
 
 KPluginFactory (const KAboutData &aboutData, QObject *parent=0)
 
KDE_CONSTRUCTOR_DEPRECATED KPluginFactory (const KAboutData *aboutData, QObject *parent=0)
 
KDE_CONSTRUCTOR_DEPRECATED KPluginFactory (QObject *parent)
 
virtual ~KPluginFactory ()
 
KComponentData componentData () const
 
T * create (const QString &keyword, QObject *parent=0, const QVariantList &args=QVariantList())
 
T * create (QObject *parent, const QStringList &args)
 
QObject * create (QObject *parent=0, const char *classname="QObject", const QStringList &args=QStringList())
 
T * create (QObject *parent=0, const QVariantList &args=QVariantList())
 
T * create (QWidget *parentWidget, QObject *parent, const QString &keyword=QString(), const QVariantList &args=QVariantList())
 

Additional Inherited Members

- Signals inherited from KPluginFactory
void objectCreated (QObject *object)
 
- Static Public Member Functions inherited from KParts::Factory
static KComponentData partComponentDataFromLibrary (const QString &libraryName)
 
- Protected Types inherited from KPluginFactory
typedef QObject *(* CreateInstanceFunction) (QWidget *, QObject *, const QVariantList &)
 
- Protected Member Functions inherited from KParts::Factory
virtual QObject * createObject (QObject *parent=0, const char *classname="QObject", const QStringList &args=QStringList())
 
virtual Part * createPartObject (QWidget *parentWidget=0, QObject *parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())=0
 
- Protected Member Functions inherited from KPluginFactory
 KPluginFactory (KPluginFactoryPrivate &dd, QObject *parent=0)
 
virtual QObject * create (const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword)
 
virtual QObject * createObject (QObject *parent, const char *className, const QStringList &args)
 
virtual KParts::Part * createPartObject (QWidget *parentWidget, QObject *parent, const char *classname, const QStringList &args)
 
void registerPlugin (const QString &keyword=QString(), CreateInstanceFunction instanceFunction=InheritanceChecker< T >().createInstanceFunction(reinterpret_cast< T * >(0)))
 
void setComponentData (const KComponentData &componentData)
 
virtual void setupTranslations ()
 
QVariantList stringListToVariantList (const QStringList &list)
 
QStringList variantListToStringList (const QVariantList &list)
 
- Static Protected Member Functions inherited from KPluginFactory
static QObject * createInstance (QWidget *parentWidget, QObject *parent, const QVariantList &args)
 
static QObject * createPartInstance (QWidget *parentWidget, QObject *parent, const QVariantList &args)
 
- Protected Attributes inherited from KPluginFactory
KPluginFactoryPrivate *const d_ptr
 

Detailed Description

Accessor to the Editor implementation.

Topics:

  • Introduction
  • Creating an Editor Part
  • Notes

Introduction

The Factory provides access to the chosen Editor (selected with KTextEditor::EditorChooser). The Editor itself then provides methods to handle documents and config options.

To access the Editor use editor().

Each KTextEditor implementation must reimplement this factory to allow access to the editor object.

Creating an Editor Part

To get a kate part the following code snippet can be used:

KLibFactory* factory = KLibLoader::self()->factory("katepart");
KTextEditor::Factory* kte_factory =
qobject_cast<KTextEditor::Factory*>(factory);
if(kte_factory) {
// valid editor factory, it is possible to access the editor now
KTextEditor::Editor* editor = kte_factory->editor();
} else {
// error
}
KLibLoader::self
static KLibLoader * self()
KLibLoader::factory
KPluginFactory * factory(const QString &libname, QLibrary::LoadHints loadHint=0)
KPluginFactory
KTextEditor::Editor
Accessor interface for Editor part.
Definition: editor.h:103
KTextEditor::Factory
Accessor to the Editor implementation.
Definition: factory.h:91
KTextEditor::Factory::editor
virtual Editor * editor()=0
Get the global Editor object.

If another editor part is desired substitue the string "katepart" with the corresponding library name.

However, if you are only interested in getting the editor part (which is usually the case) a simple call of

KTextEditor::Editor* editor = KTextEditor::editor("katepart");
KTextEditor::editor
Editor * editor(const char *libname)
Helper function for the EditorChooser.
Definition: ktexteditor.cpp:173

is enough.

Notes

It is recommend to use the EditorChooser to get the used editor part. This way the user can choose the editor implementation. The Factory itself is not needed to get the Editor with the help of the EditorChooser.

See also
KParts::Factory, KTextEditor::Editor
Author
Christoph Cullmann <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

Definition at line 90 of file factory.h.

Constructor & Destructor Documentation

◆ Factory()

Factory::Factory ( QObject *  parent)

Constructor.

Create a new Factory with parent.

Parameters
parentparent object

Definition at line 67 of file ktexteditor.cpp.

◆ ~Factory()

Factory::~Factory ( )
virtual

Virtual destructor.

Reimplemented from KParts::Factory.

Definition at line 73 of file ktexteditor.cpp.

Member Function Documentation

◆ editor()

virtual Editor * KTextEditor::Factory::editor ( )
pure virtual

Get the global Editor object.

The editor part implementation must ensure that this object lives as long as any factory or document object exists.

Returns
global KTextEditor::Editor object

The documentation for this class was generated from the following files:
  • factory.h
  • ktexteditor.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.

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • 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