mcrl2::gui::qt::CodeEditor =============================================================================== Include file: .. code-block:: c++ #include "mcrl2/gui/codeeditor.h .. cpp:class:: mcrl2::gui::qt::CodeEditor The CodeEditor class defines a text editor for code (used for specification and properties) Private attributes ------------------------------------------------------------------------------- .. cpp:member:: QFont mcrl2::gui::qt::CodeEditor::codeFont .. cpp:member:: CodeHighlighter * mcrl2::gui::qt::CodeEditor::highlighter .. cpp:member:: bool mcrl2::gui::qt::CodeEditor::isSpecificationEditor .. cpp:member:: bool mcrl2::gui::qt::CodeEditor::lightPalette .. cpp:member:: LineNumberArea * mcrl2::gui::qt::CodeEditor::lineNumberArea .. cpp:member:: QFont mcrl2::gui::qt::CodeEditor::lineNumberFont .. cpp:member:: QAction * mcrl2::gui::qt::CodeEditor::zoomInAction .. cpp:member:: QAction * mcrl2::gui::qt::CodeEditor::zoomOutAction Public member functions ------------------------------------------------------------------------------- .. cpp:function:: void changeHighlightingRules() changeHighlightingRules Change the highlighting rules depending on the purpose of the code editor and its colour palette .. cpp:function:: CodeEditor(QWidget *parent=0) CodeEditor Constructor. **Parameters:** * **parent** The parent of this widget .. cpp:function:: void lineNumberAreaPaintEvent(QPaintEvent *event) lineNumberAreaPaintEvent Paints the line number area on the screen **Parameters:** * **event** A paint event .. cpp:function:: int lineNumberAreaWidth() lineNumberAreaWidth Computes the width needed for the line number area **Returns:** The width needed for the line number area .. cpp:function:: void setPurpose(bool isSpecificationEditor) setPurpose Set whether this code editor is for editing specifications or mu-calculus formulae **Parameters:** * **isSpecificationEditor** Whether this code editor is for editing specifications .. cpp:function:: ~CodeEditor() public-slot ------------------------------------------------------------------------------- mcrl2::gui::qt::CodeEditor::deleteChar deleteChar Allows the user to delete text mcrl2::gui::qt::CodeEditor::zoomIn zoomIn Allows the user to zoom in on the text **Parameters:** * **range** How much to zoom in mcrl2::gui::qt::CodeEditor::zoomOut zoomOut Allows the user to zoom out from the text **Parameters:** * **range** How much to zoom out Protected member functions ------------------------------------------------------------------------------- .. cpp:function:: void changeEvent(QEvent *event) override changeEvent Changes the syntax highlighting when the colour palette of the window changes event The change event .. cpp:function:: void keyPressEvent(QKeyEvent *event) override keyPressEvent Adds key events for zooming **Parameters:** * **event** The key event .. cpp:function:: void paintEvent(QPaintEvent *event) override paintEvent Adds placeholder text **Parameters:** * **event** The paint event .. cpp:function:: void resizeEvent(QResizeEvent *event) override resizeEvent Resizes the line number area when the window is resized **Parameters:** * **event** The resize event .. cpp:function:: void wheelEvent(QWheelEvent *event) override wheelEvent Adds mouse wheel events for zooming **Parameters:** * **event** The mouse wheel event Private member functions ------------------------------------------------------------------------------- .. cpp:function:: bool characterIsCommentedOut(const QString &text, int pos) characterIsCommentedOut Checks whether the character at the given position in the given string is commented out **Parameters:** * **text** The text to check the character in * **pos** The position of the character to check for in the text return Whether the character is commented out .. cpp:function:: void highlightCurrentLine() highlightCurrentLine Highlights the line the cursor is on .. cpp:function:: void highlightParentheses() highlightParentheses Highlights the parenthesis that corresponds to the one the cursor is next to .. cpp:function:: int matchingParenthesisPosition(int toMatchPos, int direction) matchingParenthesisPosition Finds the position of the parenthesis that matches the one on the given position in the given direction **Parameters:** * **toMatchPos** The position in the text of the parenthesis to match with * **direction** In which direction to look for the matching parenthesis. Equals 1 if we need to look forward for a ')', equals -1 if we need to look back for a '('. .. cpp:function:: QTextEdit::ExtraSelection parenthesisHighlighting(int position) parenthesisHighlighting Creates a highlighting for a single character on a given position for highlighting matching parentheses **Parameters:** * **position** The position of the character to highlight **Returns:** A selection that defines a highlighted parenthesis .. cpp:function:: void setFontSize(int pixelSize) setFontSize Sets the font size and tab width **Parameters:** * **pixelSize** The desired font size in pixels private-slot ------------------------------------------------------------------------------- mcrl2::gui::qt::CodeEditor::showContextMenu showContextMenu Creates and shows a context menu **Parameters:** * **position** The position where to create the context menu mcrl2::gui::qt::CodeEditor::updateLineNumberArea updateLineNumberArea Updates the line number area after the scrollbar has been used **Parameters:** * **rect** The rectangle that covers the line number area * **dy** The amount of pixels scrolled mcrl2::gui::qt::CodeEditor::updateLineNumberAreaWidth updateLineNumberAreaWidth Updates the width of the line number area