# class KTextEditor.EditorChooser

###

Table of contents
Modules
ktexteditor Classes
All Classes

Module | ktexteditor
Namespace | ktexteditor
Class | KTextEditor.EditorChooser
Inherits | QWidget

Editor Component Chooser.

Topics: - chooser_intro - chooser_gui - chooser_editor

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.

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 chooser_gui). Example:

    KTextEditor.Editor* editor = KTextEditor.EditorChooser.editor();

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

### methods

- EditorChooser (parent)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget | None

  Constructor.

  Create an editor chooser widget.

  parent - the parent widget

- changed () signal

  returns nothing
  SIGNAL ("changed ()")

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

- editor (postfix, fallBackToKatePart)

  returns (KTextEditor.Editor)
  static

  Argument | Type | Default
  --- | --- | ---
  postfix | QString | QString ()
  fallBackToKatePart | bool | True

  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 0, that extension is supported:

  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 0, if no editor component could be found

- readAppSetting (postfix)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  postfix | QString | 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.

  postfix - config group postfix string

  See also writeAppSetting()

- writeAppSetting (postfix)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  postfix | QString | QString ()

  Write the configuration to the application's config file.

  postfix - config group postfix string

  See also readAppSetting()