KTextEditor::SessionConfigInterface Class Reference

#include <KTextEditor/SessionConfigInterface>

Public Member Functions
virtual	~SessionConfigInterface ()
virtual void	readSessionConfig (const KConfigGroup &config)=0
virtual void	writeSessionConfig (KConfigGroup &config)=0

Detailed Description

Session config interface extension for the Plugin and Plugin views.

Introduction

The SessionConfigInterface is an extension for Plugins and Plugin views to add support for session-specific configuration settings. readSessionConfig() is called whenever session-specific settings are to be read from the given KConfigGroup and writeSessionConfig() whenever they are to be written, for example when a session changed or was closed.

Note

A session does not have anything to do with an X-session under Unix. What is meant is rather a context, think of sessions in Kate or projects in KDevelop for example.

Adding Session Support

To add support for sessions, your Plugin has to inherit the SessionConfigInterface and reimplement readSessionConfig() and writeSessionConfig().

Accessing the SessionConfigInterface

This section is for application developers such as Kate, KDevelop, etc that what to support session configuration for plugins.

The SessionConfigInterface is an extension interface for a Plugin or a Plugin view, i.e. Plugin/Plugin view inherits the interface provided that it implements the interface. Use qobject_cast to access the interface:

// object is of type Plugin* or, in case of a plugin view, QObject*
KTextEditor::SessionConfigInterface *iface =
    qobject_cast<KTextEditor::SessionConfigInterface*>( object );
 
if( iface ) {
    // interface is supported
    // do stuff
}

See also

KTextEditor::Plugin

Author

Christoph Cullmann <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

Definition at line 67 of file sessionconfiginterface.h.

Constructor & Destructor Documentation

~SessionConfigInterface()

SessionConfigInterface::~SessionConfigInterface ( )

virtualdefault

Virtual destructor.

Member Function Documentation

readSessionConfig()

virtual void KTextEditor::SessionConfigInterface::readSessionConfig ( const KConfigGroup & config )

pure virtual

Read session settings from the given config.

That means for example

• a Document should reload the file, restore all marks etc...
• a View should scroll to the last position and restore the cursor position etc...
• a Plugin should restore session specific settings
• If no file is being loaded, because an empty new document is going to be displayed, this function should emit ReadOnlyPart::completed

Parameters

config

read the session settings from this KConfigGroup

See also

writeSessionConfig()

writeSessionConfig()

virtual void KTextEditor::SessionConfigInterface::writeSessionConfig ( KConfigGroup & config )

pure virtual

Write session settings to the config.

See readSessionConfig() for more details.

Parameters

config

write the session settings to this KConfigGroup

See also

readSessionConfig()

---

The documentation for this class was generated from the following files:

• sessionconfiginterface.h
• ktexteditor.cpp