edbee lib

Edbee-lib

EDBEE是基於QT的編輯器組件。它支持多層，文本範圍/語法和突出顯示支持。

Edbee的基類是Qwidget，它是從頭開始寫的，不是基於QT默認編輯器組件。

EDBEE的主要網站位於http://edbee.net/您可以在http://docs.edbee.net/上找到生成的文檔。

該存儲庫是對以前的Edbee單片存儲庫的干淨提取。該庫不包含任何數據文件。使用它應該變得像以下示例一樣容易：

# include " edbee/edbee.h "
edbee::TextEditorWidget* widget =  new edbee::TextEditorWidget();

不幸的是，我們目前還沒有。當前，如果不加載默認的KeyMap文件，EDBEE庫將無法運行。

例子

使用組件非常容易。首先，您必須設置Edbee環境。需要此過程才能使庫知道設置文件的位置：

# include " edbee/edbee.h "

// get the edbee instance
edbee::Edbee* tm = edbee::Edbee::instance();

// configure your paths
tm -> setKeyMapPath ( " location/of/your/keymap/ " );
tm -> setGrammarPath (  " location/of/your/syntaxfiles/ " );
tm -> setThemePath ( " location/of/your/themes/ " );

// initialize the library
tm -> init ();

// by registering a shutdown function on application exit you don't have to destroy the edbee
// resources yourself. It will result in a clean shutdown
tm -> autoShutDownOnAppExit ();

之後，您準備出發了。您可以創建一個小部件：

edbee::TextEditorWidget* widget =  new edbee::TextEditorWidget();

當然，最好將編輯器填充文件。您可以使用隨附的序列化器為此。

# include " edbee/io/textdocumentserializer.h "
# include " edbee/texteditorwidget.h "

edbee::TextEditorWidget* widget =  new edbee::TextEditorWidget();
edbee::TextDocumentSerializer serializer ( widget-> textDocument () );
QFile file ( QStringLiteral( " your-filename.rb " ) );
if ( !serializer.load( &file ) ) {
    QMessageBox::warning ( this , tr ( " Error opening file " ), tr ( " Error opening file! n %1 " ). arg (serializer. errorString ()) );
}

加載文本文件後，可以檢測該文件的語法/語言。 EDBEE庫使用基於擴展的文件類型檢測。當然，您也可以自己插入。

# include " edbee/edbee.h "
# include " edbee/models/textdocument.h "
# include " edbee/models/textgrammar.h "
# include " edbee/texteditorwidget.h "

TextGrammarManager* grammarManager = edbee::Edbee::instance()-> grammarManager ();
TextGrammar* grammar = grammarManager-> detectGrammarWithFilename ( " a-ruby-file.rb " );
widget-> textDocument ()->setLanguagGrammar( grammar );

自動完成

Edbee支持自動完成。目前，這非常有限，但是已經為支持更先進的自動完成而做出了基礎。

通過查詢自動完成提供商（TextautoCompleteprovider）來自動完成工作。它通過eDbee :: instance（）級別具有文本document級別的textautocompleteproviderList。

當前，僅實現了StringTextautococtleteprovider。您可以在文檔級別和Edbeel級別上添加自動完成列表。

對未來的想法

• 它應該使用模糊搜索
• 單詞應獲得優先級，應與此優先級分類
• 提供者基於當前文本文檔中現有單詞。 （這需要一些智能的非UI-UI-blocking Word list建築）
• 提供者基於當前範圍。關鍵字取決於活動的TextDocumentsCopes（語言特定/上下文特定列表）
• 支持文本人/崇高像摘要（帶有標籤停止）

當前，您可以設置這樣的關鍵字列表：

# include " edbee/models/textautocompleteprovider.h "

StringTextAutoCompleteProvider* provider = new StringTextAutoCompleteProvider();
provider-> add ( " const " );
provider-> add ( " class " );
provider-> add ( " compare " );
// etc ...

// to add it Locally (specific to the given document)
textDocument-> autoCompleteProviderList ()->giveProvider(provider);

// to add it Globally:
Edbee::instance ()->autoCompleteProviderList()->giveProvider(provider);

已知問題

• 項目尚未分類（這應該是優先級）
• 當前，自動錄製窗口的位置不是很聰明。 （特別是在文檔的底部和側面）
• backpace隱藏了窗戶

技巧和竅門

對象名稱衝突

當您使用QT項目使用時，例如util.cpp，您可以獲得對象文件式擠壓。 （makefile：警告：目標util.o的覆蓋命令）。這樣做的解決方法正在附加您的以下幾行（Objects_dir是可選的，但在運行QMAKE時會防止警告）

 CONFIG += object_parallel_to_source in your .pro file
OBJECTS_DIR = objects

已知問題和缺失功能

• 編輯器不支持文字包裝。 （然而）
• 它有排隊的問題。原因是QTEXTLAYOUT的性質和可變字體大小的支持。將來，這可以解決單層字體。
• 更好的渲染支持和背景計算/油漆功能的最佳功能
• 我真的想在腳本支持中構建，以用插件擴展編輯器。

貢獻

您可以通過Github貢獻

• 叉
• 創建您的功能分支（git Checkout -B my-new-feature）
• 提交您的更改（git commit -am'添加了一些功能'）
• 推到分支（git推出來源我的新功能）
• 創建新的拉請求

當然，您還可以通過Twitter @GameCreature與我聯繫，或通過https://github.com/gamecreature給我留言。

問題？

儘管我們在（http://issues.edbee.net/）上有自己的問題跟踪器，但您可以通過github essue tracker報告問題，或向我發送消息https://github.com/gamecreature