edbee - Qt Editor Library
Public Slots | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
edbee::Edbee Class Reference

The texteditor manager, It manages all singleton objects for the editor It performs the initialization and shutdown code for all editors. More...

#include <edbee.h>

+ Inheritance diagram for edbee::Edbee:
+ Collaboration diagram for edbee::Edbee:

Public Slots

void init ()
 initializes the engine on startup More...
 
void shutdown ()
 destroys the texteditor manager and all related class More...
 
void autoShutDownOnAppExit ()
 Call this method to automaticly shutdown the texteditor manager on shutdown (This method listens to the qApp::aboutToQuit signal. More...
 

Public Member Functions

void setKeyMapPath (const QString &keyMapPath)
 sets the path where to find the keymap files More...
 
void setGrammarPath (const QString &grammarPath)
 Sets the grammar path. More...
 
void setThemePath (const QString &themePath)
 Setst the path where to find the theme files. More...
 
void autoInit ()
 This method automaticly initializes the edbee library it this hasn't already been done. More...
 
TextEditorKeyMapdefaultKeyMap ()
 returns the default editor keymap More...
 
TextEditorCommandMapdefaultCommandMap ()
 Returns the default editor command map. This is the default command map that's used by the editor components. More...
 
TextCodecManagercodecManager ()
 Returns the codec-manager for Edbee. More...
 
TextScopeManagerscopeManager ()
 Returns the scope manager. The scope manager is a general class to share scope names and identifiers between different editors. More...
 
TextGrammarManagergrammarManager ()
 Returns the grammar manager used by all editors The grammar manager is used for sharing the different grammar definitions between the different editors. More...
 
TextThemeManagerthemeManager ()
 Returns the theme manager The theme manager is used to share themes between the different editors. More...
 
TextKeyMapManagerkeyMapManager ()
 Returns the keymap manager. More...
 
DynamicVariablesenvironmentVariables ()
 Rreturns the dynamicvariables object. More...
 

Static Public Member Functions

static Edbeeinstance ()
 The singleton instance getter. More...
 

Protected Attributes

bool inited_
 This method is set to true if the manager is inited. More...
 
QString grammarPath_
 The path were to load all grammars from. More...
 
QString themePath_
 The path to load all themes from. More...
 
QString keyMapPath_
 The path to load all keymaps. More...
 
TextEditorCommandMapdefaultCommandMap_
 The default command map. More...
 
TextCodecManagercodecManager_
 The text-editor codec manager. More...
 
TextScopeManagerscopeManager_
 The text-scope manager. More...
 
TextGrammarManagergrammarManager_
 The grammar manager. More...
 
TextThemeManagerthemeManager_
 The text theme manager. More...
 
TextKeyMapManagerkeyMapManager_
 The keymap manager. More...
 
DynamicVariablesenvironmentVariables_
 The (dynamic) environment variables. More...
 

Detailed Description

The texteditor manager, It manages all singleton objects for the editor It performs the initialization and shutdown code for all editors.

Member Function Documentation

◆ autoInit()

void edbee::Edbee::autoInit ( )

This method automaticly initializes the edbee library it this hasn't already been done.

◆ autoShutDownOnAppExit

void edbee::Edbee::autoShutDownOnAppExit ( )
slot

Call this method to automaticly shutdown the texteditor manager on shutdown (This method listens to the qApp::aboutToQuit signal.

◆ codecManager()

TextCodecManager * edbee::Edbee::codecManager ( )

Returns the codec-manager for Edbee.

◆ defaultCommandMap()

TextEditorCommandMap * edbee::Edbee::defaultCommandMap ( )

Returns the default editor command map. This is the default command map that's used by the editor components.

Returns
the default command map

◆ defaultKeyMap()

TextEditorKeyMap * edbee::Edbee::defaultKeyMap ( )

returns the default editor keymap

◆ environmentVariables()

DynamicVariables * edbee::Edbee::environmentVariables ( )

Rreturns the dynamicvariables object.

◆ grammarManager()

TextGrammarManager * edbee::Edbee::grammarManager ( )

Returns the grammar manager used by all editors The grammar manager is used for sharing the different grammar definitions between the different editors.

◆ init

void edbee::Edbee::init ( )
slot

initializes the engine on startup

◆ instance()

Edbee * edbee::Edbee::instance ( )
static

The singleton instance getter.

◆ keyMapManager()

TextKeyMapManager * edbee::Edbee::keyMapManager ( )

Returns the keymap manager.

◆ scopeManager()

TextScopeManager * edbee::Edbee::scopeManager ( )

Returns the scope manager. The scope manager is a general class to share scope names and identifiers between different editors.

◆ setGrammarPath()

void edbee::Edbee::setGrammarPath ( const QString &  grammarPath)

Sets the grammar path.

Parameters
grammarPaththe path with the grammar files

◆ setKeyMapPath()

void edbee::Edbee::setKeyMapPath ( const QString &  keyMapPath)

sets the path where to find the keymap files

Parameters
keyMapPaththe path with keymap files

◆ setThemePath()

void edbee::Edbee::setThemePath ( const QString &  themePath)

Setst the path where to find the theme files.

Parameters
themePaththe path to find the themes

◆ shutdown

void edbee::Edbee::shutdown ( )
slot

destroys the texteditor manager and all related class

◆ themeManager()

TextThemeManager * edbee::Edbee::themeManager ( )

Returns the theme manager The theme manager is used to share themes between the different editors.

Member Data Documentation

◆ codecManager_

TextCodecManager* edbee::Edbee::codecManager_
protected

The text-editor codec manager.

◆ defaultCommandMap_

TextEditorCommandMap* edbee::Edbee::defaultCommandMap_
protected

The default command map.

◆ environmentVariables_

DynamicVariables* edbee::Edbee::environmentVariables_
protected

The (dynamic) environment variables.

◆ grammarManager_

TextGrammarManager* edbee::Edbee::grammarManager_
protected

The grammar manager.

◆ grammarPath_

QString edbee::Edbee::grammarPath_
protected

The path were to load all grammars from.

◆ inited_

bool edbee::Edbee::inited_
protected

This method is set to true if the manager is inited.

◆ keyMapManager_

TextKeyMapManager* edbee::Edbee::keyMapManager_
protected

The keymap manager.

◆ keyMapPath_

QString edbee::Edbee::keyMapPath_
protected

The path to load all keymaps.

◆ scopeManager_

TextScopeManager* edbee::Edbee::scopeManager_
protected

The text-scope manager.

◆ themeManager_

TextThemeManager* edbee::Edbee::themeManager_
protected

The text theme manager.

◆ themePath_

QString edbee::Edbee::themePath_
protected

The path to load all themes from.


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