summaryrefslogtreecommitdiff
path: root/fluid/documentation/src/page_codeview_panel.dox
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2024-04-17 17:51:32 +0200
committerGitHub <noreply@github.com>2024-04-17 17:51:32 +0200
commitfd791a068e39e06785adc44693f4c533d3d6c903 (patch)
treeef7ff684b38f646165e80c142e454cd7ef077e2e /fluid/documentation/src/page_codeview_panel.dox
parentb4cf1a9824f2c4ba9596044962d3af36e3ca3d99 (diff)
Separate FLUID user documentation, screen shot automation (#936)
* CMake integration, no autotiools * alignment panel is now correctly renamed to setting panel * source view is now correctly renamed to code view * Merge FLTK FLUID docs into FLUID user manual. * Add two simple entry tutorials * Remove FLUID chapter form FLTK docs. * GitHub action to generate HTML and PDF docs and make the available as artefacts
Diffstat (limited to 'fluid/documentation/src/page_codeview_panel.dox')
-rw-r--r--fluid/documentation/src/page_codeview_panel.dox76
1 files changed, 76 insertions, 0 deletions
diff --git a/fluid/documentation/src/page_codeview_panel.dox b/fluid/documentation/src/page_codeview_panel.dox
new file mode 100644
index 000000000..2fac1a286
--- /dev/null
+++ b/fluid/documentation/src/page_codeview_panel.dox
@@ -0,0 +1,76 @@
+/**
+
+ \page page_codeview_panel Code View Panel
+
+ \tableofcontents
+
+ # The Code View Panel #
+
+ \image html codeview_panel.png "Code View Panel"
+ \image latex codeview_panel.png "Code View Panel" width=9cm
+
+ The Code View panel shows all code files that can be generated by FLUID.
+
+ The Code View window can be activated via the main
+ menu: *Edit* > *Show Source Code* . FLUID will remember the state and
+ dimensions of the Code View panel.
+
+ If the Auto-Refresh option is selected, the code views will be updated
+ automatically while editing the project.
+
+ Code View has four tabs. The first tab shows the source code. Inlined data
+ is omitted in the code view for brevity.
+
+ The second tab shows the content of the header file. The size of inline data
+ is not calculated and shown as `-1`.
+
+ The third tab shows the list of labels and tooltips as they would be written
+ to a translation file, using the selected project internationalization method.
+
+ The fourth tab previews the contents of the `.fl` project file.
+
+ <!-- ---------------------------------------------------------------------- -->
+ \section codeview_find Code View Find
+
+ \image html cv_find_row.png
+ \image latex cv_find_row.png "Find in Code" width=9cm
+
+ This group of buttons makes it easy to find any text in the Source, Header, or
+ Project file. Press *Reveal* to select the widget that generated the indicated
+ line of code.
+
+ __Find__: enter any text you may want to find in the current tab
+
+ __aA__: press this button to activate case sensitive search
+
+ __&lt;&lt;__, __&gt;&gt;__: find the previous or next occurrence
+
+ __Reveal__: clicking this button reveals the widget that generated the
+ selected code in the widget browser
+
+ <!-- ---------------------------------------------------------------------- -->
+ \section codeview_settings Code View Settings
+
+ \image html cv_settings_row.png
+ \image latex cv_settings_row.png "Code View Settings" width=9cm
+
+ __Refresh__: preview the code in the selected tab as it would be generated
+ for the project in its current state
+
+ __Auto-Refresh__: Automatically refresh the code view when the project changes.
+ The Auto Refresh is designed to use relatively little resources, even when
+ continuously updating the selected code tab.
+ The Code View window can usually stay open and auto refresh during the entire
+ design process, even for relatively complex GUIs.
+
+ __Auto-Position__: highlight and reposition to the source code generated by
+ the currently selected widget whenever the selection changes
+
+ __code...__: choose the type of code that is highlighted. In source
+ files, *static* code is generated by Menu Items, *code* refers to widget
+ creation code, *code1* is the part before possible children, *code2* is
+ code generated after children. In header files, *static* highlights
+ `#include` statements generated by a widget, *code* refers to
+ the widget declaration.
+
+*/