KTextEditor
#include <sessionconfiginterface.h>
Public Types | |
enum | SessionConfigParameter { SkipNone = 0, SkipUrl = 1 << 0, SkipMode = 1 << 1, SkipHighlighting = 1 << 2, SkipEncoding = 1 << 3, SkipFolding = 1 << 4 } |
Public Member Functions | |
ParameterizedSessionConfigInterface () | |
virtual | ~ParameterizedSessionConfigInterface () |
virtual void | readParameterizedSessionConfig (const KConfigGroup &config, unsigned long parameters)=0 |
virtual void | writeParameterizedSessionConfig (KConfigGroup &config, unsigned long parameters)=0 |
Detailed Description
Parameterized session config interface extension for the Document.
Introduction
The ParameterizedSessionConfigInterface is an extension for Documents to add support for session-specific configuration settings with more fine-grained control over the settings that are manipulated. The readParameterizedSessionConfig() method is called whenever session-specific settings are to be read from the given KConfig* and the writeParameterizedSessionConfig() method 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.
- ParameterizedSessionConfigInterface is meant to be an extension of SessionConfigInterface. Due to limitations with qobject_cast it is not possible in KDE4 to derive this interface from SessionConfigInterface.
Adding Session Support
To add support for sessions a KTextEditor implementation has to derive the Document class from ParameterizedSessionConfigInterface and reimplement the methods defined in this class.
Accessing the ParameterizedSessionConfigInterface
The ParameterizedSessionConfigInterface is supposed to be an extension interface for a Document i.e. the Document inherits the interface provided that it implements the interface. Use qobject_cast to access the interface:
- Since
- 4.4
- Note
- KDE5: Rename to SessionConfigInterface, delete old SessionConfigInterface
Definition at line 176 of file sessionconfiginterface.h.
Member Enumeration Documentation
Flags for session restore.
These flags allow to skip some parts of the configuration from restoration.
Enumerator | |
---|---|
SkipNone | |
SkipUrl | |
SkipMode | |
SkipHighlighting | |
SkipEncoding | |
SkipFolding |
Definition at line 192 of file sessionconfiginterface.h.
Constructor & Destructor Documentation
ParameterizedSessionConfigInterface::ParameterizedSessionConfigInterface | ( | ) |
Definition at line 260 of file ktexteditor.cpp.
|
virtual |
Virtual destructor.
Definition at line 263 of file ktexteditor.cpp.
Member Function Documentation
|
pure virtual |
Read session settings from the given config
excluding the settings specified in parameters
.
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 or 'SkipUrl' is set, this function should emit ReadOnlyPart::completed
- Parameters
-
config read the session settings from this KConfigGroup parameters settings that should not be read (i.e. a combination of flags from SessionConfigParameter)
|
pure virtual |
Write session settings to the config
excluding the settings specified in parameters
.
See readSessionConfig() for more details.
- Parameters
-
config write the session settings to this KConfigGroup parameters settings that should not be written (i.e. a combination of flags from SessionConfigParameter)
- See also
- readParameterizedSessionConfig()
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:52:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.