Menu ▾ ▴

#670 Enable tooltips for the command line

v1.1.x
closed
Erik Hänel
gui (58) documentation (9) terminal (7)
v1.1.4
New Functionality
2022-03-10
2022-02-20
Erik Hänel
No

If we use the command line more excessive, we face the issue that we have to look up all the signatures in the symbols tree instead of looking at the (missing) tooltip. Add tooltips, which show at least the signatures of the symbols in the command line.

Analysis:

We'll use a custom wxWindow as tooltip, for which we'll deactivate the focusing. The custom window can be shown and hidden. The actual content of the tooltip will be rendered by an embedded wxTextCtrl, which may also apply the highlighting effect to its text.

Implementation:

  • Implementation: Implemented as proposed by the analysis.
  • Revision: [r1076]
  • Implementation test: Different command lines were examined and the context-specific tooltips are working as expected

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [ ] corresponding language files updated
    • [x] not needed

Tests:

Tooltips work as expected.

Related

Commit: [r1076]
Tickets: #510

Discussion

  • Erik Hänel

    Erik Hänel - 2022-02-20
    • labels: --> gui, documentation, terminal
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2022-02-20
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 If we use the command line more excessive, we face the issue that we have to look up all the signatures in the symbols tree instead of looking at the (missing) tooltip. Add tooltips, which show at least the signatures of the symbols in the command line.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2022-02-20
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 If we use the command line more excessive, we face the issue that we have to look up all the signatures in the symbols tree instead of looking at the (missing) tooltip. Add tooltips, which show at least the signatures of the symbols in the command line.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+We'll use a custom `wxWindow` as tooltip, for which we'll deactivate the focusing. The custom window can be shown and hidden. The actual content of the tooltip will be rendered by an embedded `wxTextCtrl`, which may also apply the highlighting effect to its text.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2022-02-20
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,20 +4,20 @@
 We'll use a custom `wxWindow` as tooltip, for which we'll deactivate the focusing. The custom window can be shown and hidden. The actual content of the tooltip will be rendered by an embedded `wxTextCtrl`, which may also apply the highlighting effect to its text.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Implemented as proposed by the analysis.
+* Revision: [r1076]
+* Implementation test: Different command lines were examined and the context-specific tooltips are working as expected

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
     * [ ] corresponding language files updated
-    * [ ] not needed
+    * [x] not needed

 ###Tests:
 (*Describe, which tests you performed and their outcome*)
    • status: implementing --> testing
     

    Related

    Commit: [r1076]

  • Erik Hänel

    Erik Hänel - 2022-03-10
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Tooltips work as expected.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel