Skip to content

Commit

Permalink
Add documentation for the widget bin.
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthiasWM committed Mar 18, 2024
1 parent ce40ecf commit dbba0ab
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 4 deletions.
10 changes: 6 additions & 4 deletions fluid/autodoc.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@ void run_autodoc(const Fl_String &target_dir) {
widget_browser->rebuild();
g_project.update_settings_dialog();

// TODO: explain FLUID command line usage

// TODO: take a snapshot of FLUID in a desktop situation
// (main, toolbar, document, widget editor, source view)

Expand All @@ -394,12 +396,15 @@ void run_autodoc(const Fl_String &target_dir) {
// explain widget browser
// explain widget browser entry

// TODO: toolbar
// ---- widget bin
// show grouping
// explain non-widget types and where they will be located
// explain widgets types an their dnd option
// explain menu arrays
// list exceptions (subwindow, scroll)
if (!widgetbin_panel) make_widgetbin();
fl_snapshot((target_dir + "widgetbin_panel.png").c_str(), widgetbin_panel, win_margin, win_blend);


// TODO: document view
// explain dnd
Expand All @@ -415,11 +420,8 @@ void run_autodoc(const Fl_String &target_dir) {
if (!sourceview_panel) make_sourceview();
update_sourceview_cb(NULL, NULL);
sv_tab->value(sv_source_tab);
//: sourceview_panel
fl_snapshot((target_dir + "sourceview_panel.png").c_str(), sourceview_panel, win_margin, win_blend);
//: cv_find_row
fl_snapshot((target_dir + "cv_find_row.png").c_str(), cv_find_row, row_margin, row_blend);
//: cv_settings_row
fl_snapshot((target_dir + "cv_settings_row.png").c_str(), cv_settings_row, row_margin, row_blend);

// ---- settings dialog
Expand Down
1 change: 1 addition & 0 deletions fluid/documentation/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -783,6 +783,7 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched.

INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/index.dox \
@CMAKE_CURRENT_SOURCE_DIR@/src/page_widgetbin_panel.dox \
@CMAKE_CURRENT_SOURCE_DIR@/src/page_functional_nodes.dox \
@CMAKE_CURRENT_SOURCE_DIR@/src/page_widget_panel.dox \
@CMAKE_CURRENT_SOURCE_DIR@/src/page_setting_dialog.dox \
Expand Down
2 changes: 2 additions & 0 deletions fluid/documentation/src/index.dox
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@

_not yet_

\subpage page_widgetbin_panel

\subpage page_widget_panel
- \ref widget_panel_gui
- \ref widget_panel_style
Expand Down
31 changes: 31 additions & 0 deletions fluid/documentation/src/page_widgetbin_panel.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/**

\page page_widgetbin_panel Widget Bin Panel

\tableofcontents

# The Widget Bin Panel #

\image html widgetbin_panel.png "Widget Bin"
\image latex widgetbin_panel.png "Widget Bin"

The Widget Bin can be activated via the main
menu: *Edit* > *Show Widget Bin* . FLUID will remember its
state and dimensions.

The Widget Bin is a great way to quickly create a GUI project. Clicking
an icon in the bin will create the corresponding code or widget node inside
or right after the selected widget. If the parent widget is not supported
for this widget type, FLUID tries to find a better position. If that fails,
a dialog box will pop up, explaining what type of parent node is required.

The Window and Widget Class icons can be dragged onto the desktop,
creating a new window at the drop position.

All other widget types can be dragged from the bin into a window, or a group
inside a window. When dropped, they will be positioned close to the drop point
and inserted into the widget tree as the last child of the chosen group.
The order of Widgets within their group can be changed with
the `F2` and `F3` keys.

*/

0 comments on commit dbba0ab

Please sign in to comment.