• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KTextEditor

KTextEditor::EditorChooser

KTextEditor::EditorChooser Class Reference

Editor Component Chooser. More...

#include <editorchooser.h>

Inheritance diagram for KTextEditor::EditorChooser:

Inheritance graph
[legend]

List of all members.


Signals

void changed ()

Public Member Functions

 EditorChooser (QWidget *parent=0)
void readAppSetting (const QString &postfix=QString())
void writeAppSetting (const QString &postfix=QString())
virtual ~EditorChooser ()

Static Public Member Functions

static KTextEditor::Editor * editor (const QString &postfix=QString(), bool fallBackToKatePart=true)

Detailed Description

Editor Component Chooser.

Topics:

  • Introduction
  • The GUI Editor Chooser
  • Accessing the Editor Part

Introduction

The EditorChooser is responsible for two different tasks: It provides
  • a GUI, with which the user can choose the preferred editor part
  • a static accessor, with which the current selected editor part can be obtained.

The GUI Editor Chooser

The EditorChooser is a simple widget with a group box containing an information label and a combo box which lists all available KTextEditor implementations. To give the user the possibility to choose a text editor implementation, create an instance of this class and put it into the GUI:
 KTextEditor::EditorChooser* ec = new KTextEditor::EditorChooser(parent);
 // read the settings from the application's KConfig object
 ec->readAppSetting();
 // optionally connect the signal changed()
 // plug the widget into a layout
 layout->addWidget(ec);
Later, for example when the user clicks the Apply-button:
 // save the user's choice
 ec->writeAppSetting();
After this, the static accessor editor() will return the new editor part object. Now, either the application has to be restarted, or you need code that closes all current documents so that you can safely switch and use the new editor part. Restarting is probably much easier.

Note:
If you do not put the EditorChooser into the GUI, the default editor component will be used. The default editor is configurable in KDE's control center in "KDE Components > Component Chooser > Embedded Text Editor".

Accessing the Editor Part

The call of editor() will return the currently used editor part, either the KDE default or the one configured with the EditorChooser's GUI (see The GUI Editor Chooser). Example:
 KTextEditor::Editor* editor = KTextEditor::EditorChooser::editor();

See also:
KTextEditor::Editor
Author:
Joseph Wenninger <jowenn@kde.org>

Definition at line 87 of file editorchooser.h.


Constructor & Destructor Documentation

EditorChooser::EditorChooser ( QWidget *  parent = 0  ) 

Constructor.

Create an editor chooser widget.

Parameters:
parent the parent widget

Definition at line 52 of file editorchooser.cpp.

EditorChooser::~EditorChooser (  )  [virtual]

Destructor.

Definition at line 87 of file editorchooser.cpp.


Member Function Documentation

void KTextEditor::EditorChooser::changed (  )  [signal]

This signal is emitted whenever the selected item in the combo box changed.

KTextEditor::Editor * EditorChooser::editor ( const QString &  postfix = QString(),
bool  fallBackToKatePart = true 
) [static]

Static accessor to get the Editor instance of the currently used KTextEditor component.

That Editor instance can be qobject-cast to specific extensions. If the result of the cast is not NULL, that extension is supported:

Parameters:
postfix config group postfix string
fallBackToKatePart if true, the returned Editor component will be a katepart if no other implementation can be found
Returns:
Editor controller or NULL, if no editor component could be found

Definition at line 115 of file editorchooser.cpp.

void EditorChooser::readAppSetting ( const QString &  postfix = QString()  ) 

Read the configuration from the application's config file.

The group is handeled internally (it is called "KTEXTEDITOR:", but it is possible to add a string to extend the group name with postfix.

Parameters:
postfix config group postfix string
See also:
writeAppSetting()

Definition at line 93 of file editorchooser.cpp.

void EditorChooser::writeAppSetting ( const QString &  postfix = QString()  ) 

Write the configuration to the application's config file.

Parameters:
postfix config group postfix string
See also:
readAppSetting()

Definition at line 107 of file editorchooser.cpp.


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

KTextEditor

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal