Skip to content

Commit

Permalink
Many fixes to errors and typos, found by Albrecht.
Browse files Browse the repository at this point in the history
Thank you!
  • Loading branch information
MatthiasWM committed Apr 17, 2024
1 parent 3b0a4ad commit 8929d0b
Show file tree
Hide file tree
Showing 12 changed files with 101 additions and 84 deletions.
8 changes: 4 additions & 4 deletions fluid/alignment_panel.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -2442,6 +2442,7 @@ Fl_Double_Window* make_settings_window() {
w_settings_general_tab->image( image_general_64() );
w_settings_general_tab->image()->scale(36, 24, 0, 1);
w_settings_general_tab->labelsize(11);
w_settings_general_tab->hide();
{ Fl_Group* o = new Fl_Group(120, 78, 130, 25);
o->callback((Fl_Callback*)cb_);
{ scheme_choice = new Fl_Scheme_Choice(120, 78, 120, 25, "Scheme: ");
Expand Down Expand Up @@ -2679,7 +2680,6 @@ itional data in code and project files.");
w_settings_layout_tab->image()->scale(36, 24, 0, 1);
w_settings_layout_tab->labelsize(11);
w_settings_layout_tab->callback((Fl_Callback*)cb_w_settings_layout_tab);
w_settings_layout_tab->hide();
{ Fl_Box* o = new Fl_Box(25, 78, 60, 24, "Layout:");
o->labelfont(1);
o->labelsize(11);
Expand Down Expand Up @@ -2738,7 +2738,7 @@ itional data in code and project files.");
o->labelsize(11);
o->align(Fl_Align(FL_ALIGN_LEFT|FL_ALIGN_INSIDE));
} // Fl_Box* o
{ Fl_Box* o = new Fl_Box(25, 167, 60, 20, "Margin:");
{ Fl_Box* o = new Fl_Box(25, 167, 60, 20, "Margins:");
o->labelsize(11);
o->align(Fl_Align(FL_ALIGN_RIGHT|FL_ALIGN_INSIDE));
} // Fl_Box* o
Expand Down Expand Up @@ -2799,7 +2799,7 @@ itional data in code and project files.");
o->labelsize(11);
o->align(Fl_Align(FL_ALIGN_LEFT|FL_ALIGN_INSIDE));
} // Fl_Box* o
{ Fl_Box* o = new Fl_Box(25, 261, 60, 20, "Margin:");
{ Fl_Box* o = new Fl_Box(25, 261, 60, 20, "Margins:");
o->labelsize(11);
o->align(Fl_Align(FL_ALIGN_RIGHT|FL_ALIGN_INSIDE));
} // Fl_Box* o
Expand Down Expand Up @@ -2860,7 +2860,7 @@ itional data in code and project files.");
o->labelsize(11);
o->align(Fl_Align(FL_ALIGN_LEFT|FL_ALIGN_INSIDE));
} // Fl_Box* o
{ Fl_Box* o = new Fl_Box(25, 355, 60, 20, "Margin:");
{ Fl_Box* o = new Fl_Box(25, 355, 60, 20, "Margins:");
o->labelsize(11);
o->align(Fl_Align(FL_ALIGN_RIGHT|FL_ALIGN_INSIDE));
} // Fl_Box* o
Expand Down
12 changes: 6 additions & 6 deletions fluid/alignment_panel.fl
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,8 @@ Function {make_settings_window()} {open
xywh {10 10 320 530} selection_color 12 labelsize 11 labelcolor 255 resizable
} {
Fl_Group w_settings_general_tab {
label General open selected
scale_image {36 24} image {icons/general_64.png} compress_image 1 xywh {10 60 320 480} labelsize 11 resizable
label General open
scale_image {36 24} image {icons/general_64.png} compress_image 1 xywh {10 60 320 480} labelsize 11 hide resizable
} {
Fl_Group {} {
callback {propagate_load(o, v);} open
Expand Down Expand Up @@ -448,7 +448,7 @@ or just ".ext" to set extension.}
Fl_Group w_settings_layout_tab {
label Layout
callback {propagate_load(o, v);} open
scale_image {36 24} image {icons/layout_64.png} compress_image 1 xywh {10 60 320 480} labelsize 11 hide
scale_image {36 24} image {icons/layout_64.png} compress_image 1 xywh {10 60 320 480} labelsize 11
} {
Fl_Box {} {
label {Layout:}
Expand Down Expand Up @@ -622,7 +622,7 @@ g_layout_list.update_dialogs();}
xywh {85 132 235 20} labelfont 1 labelsize 11 align 20
}
Fl_Box {} {
label {Margin:}
label {Margins:}
xywh {25 167 60 20} labelsize 11 align 24
}
Fl_Value_Input {} {
Expand Down Expand Up @@ -688,7 +688,7 @@ g_layout_list.update_dialogs();}
xywh {85 226 235 20} labelfont 1 labelsize 11 align 20
}
Fl_Box {} {
label {Margin:}
label {Margins:}
xywh {25 261 60 20} labelsize 11 align 24
}
Fl_Value_Input {} {
Expand Down Expand Up @@ -754,7 +754,7 @@ g_layout_list.update_dialogs();}
xywh {85 320 235 20} labelfont 1 labelsize 11 align 20
}
Fl_Box {} {
label {Margin:}
label {Margins:} selected
xywh {25 355 60 20} labelsize 11 align 24
}
Fl_Value_Input {} {
Expand Down
4 changes: 1 addition & 3 deletions fluid/documentation/src/page_appendices.dox
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

\tableofcontents

\section appendix_app_settings Fluid Application Settings

<!-- ---------------------------------------------------------------------- -->
\section appendix_keyboard_shortcuts Keyboard Shortcuts

Expand Down Expand Up @@ -50,7 +48,7 @@ On Apple computers, use the Apple Command key instead of Ctrl.

| Action | Function in Layout Editor |
| :----: | :------------------------ |
| `LMB` | select one widget |
| `left mouse button (LMB)` | select one widget |
| `LMB-drag` | select multiple widgets with selection box |
| `Shift-LMB` | extend widget selection |
| `Shift-LMB-Drag` | toggle selection in selection box |
Expand Down
8 changes: 4 additions & 4 deletions fluid/documentation/src/page_edit_window.dox
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
border of that group will highlight. If the outline snaps to the margin
of the parent window or group, an additional arrow is drawn.

Children of the `Fl_Tabs` use the top and bottom margin from the *Tabs*
Children of `Fl_Tabs` use the top and bottom margin from the *Tabs*
section. If all children use this rule, the margin height will also be the
height of all tabs.

Expand All @@ -117,7 +117,7 @@
\image html edit_snap_size.jpg
\image latex edit_snap_size.jpg "" width=7cm

Widget size rules define a minimum size, and an increment value that may
Widget size rules define a minimum size and an increment value that may
be applied multiple times to the size. For example, with a minimum width of 25
and an increment of 10, the widget will snap horizontally to 25, 35, 45,
55, etc. .
Expand Down Expand Up @@ -173,7 +173,7 @@
group. Again, a Widget Class is recommended here.
- if children of `Fl_Grid` are again some kind of group, their internal layout
may not follow changes in the grid widgets. It's best to complete the grid
first, then add children to the grid cells later, size them correctly, and
the finally lay out the grid cell children.
first, then add children to the grid cells, size them correctly, and
then finally lay out the grid cell children.

*/
47 changes: 33 additions & 14 deletions fluid/documentation/src/page_functional_nodes.dox
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@

### Children ###

Function nodes can contain code nodes and widget trees. The topmost node of a
widget tree must be a window.
Function nodes can contain code nodes and widgets. The topmost node of a
widget tree must be a window or a group or a widget derived from those
types.
If the function node has no children, only a forward declaration will be
created in the header, but no source code will be generated.

Expand Down Expand Up @@ -64,9 +65,9 @@
}
```

If the function contains a widget, a pointer to the first widget
will be created. The default return type will match the type of the
first widget, and a pointer to the widget will be returned.
If the function contains widgets, a pointer to the first widget
will be return. The default return type will match the type of the
first widget.
```
// .h
Fl_Window* make_window();
Expand All @@ -84,19 +85,37 @@

#### Options for Functions ####

Choosing *static* in the pulldown menu will declare the function `static` in the
source file. No prototype will be generated in the header.
Choosing *static* in the pulldown menu will generate the function `static` in
the source file. No forward declaration will be generated in the header file.
```
// .cxx
static Fl_Window* make_window() { ... }
```

If the *C* option is checked, the function will be declared as a plain C
Choosing *global* will generate a forward declaration of the function in the
header file and no `static` attribute in the source file.
```
// .h
void make_window();
// .cxx
Fl_Window* make_window() { ... }
```

Additionally,
if the *C* option is checked, the function will be declared as a plain C
function in the header file.
The options *local* and *C* together are not supported.
```
// .h
extern "C" { void my_plain_c_function(); }
// .cxx
void my_plain_c_function() { ... }
```

The *local* option will generate a function in the source file with no `static`
attribute. No forward declaration will be generated in the header file.
```
// .cxx
Fl_Window* make_window() { ... }
```

### Declaring a Method ###
Expand All @@ -122,7 +141,7 @@
}
```

If the method contains at least on widget, a pointer to the topmost widget
If the method contains at least one widget, a pointer to the topmost widget
will be returned and the return type will be generated accordingly.
```
// .h
Expand Down Expand Up @@ -165,7 +184,7 @@
Fl_Window* make_window() {
```

Fluid recognizes default values in the argument list and geneartes them in the
FLUID recognizes default values in the argument list and generates them in the
declaration, but omits them in the implementation.

A short function body can be appended in the *Name* field. With no child, this
Expand All @@ -177,7 +196,7 @@

![](flCode.png) Code

Code nodes holds arbitrary C++ code that is copied verbatim into the
Code nodes hold arbitrary C++ code that is copied verbatim into the
source code file. They are commonly used inside Function nodes.

### Parents ###
Expand Down Expand Up @@ -214,7 +233,7 @@
\image html codeblock_panel.png "Code Block Properties"
\image latex codeblock_panel.png "Code Block Properties" width=7cm

The two field expect the code before and after the `{ ... }` statements. The
The two fields expect the code before and after the `{ ... }` statements. The
second field can be empty.

Two consecutive Code Blocks can be used to generate `else`/`else if`
Expand Down Expand Up @@ -312,7 +331,7 @@

![](flWidgetClass.png) Widget Class

Widget Class node creates a new widget type by deriving a class from another
The Widget Class node creates a new widget type by deriving a class from another
widget class. These are often compound widgets derived from `Fl_Group`. A less
automated but more flexible way to implement compound widgets is the Class node.

Expand Down
4 changes: 2 additions & 2 deletions fluid/documentation/src/page_introduction.dox
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@
Users have the option to include shell scripts in FLUID projects, enabling
them to directly call compilers and linkers to produce the binaries.

For medium-sized projects, a build systems such as _CMake_ or IDEs
with integrated build setups is recommended. FLUID in interactive mode
For medium-sized projects, a build system such as _CMake_ or an IDE
with integrated build setup is recommended. FLUID in interactive mode
can pre-generate C++ code files for direct compilation by the IDE.

In larger projects, FLUID projects frequently reference external resources
Expand Down
28 changes: 14 additions & 14 deletions fluid/documentation/src/page_setting_dialog.dox
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
\tableofcontents

<img src="w_settings.png" align="left" hspace="10" vspace="10" />
\image latex w_settings.png "Setting Dialog" width=7cm
\image latex w_settings.png "Settings Dialog" width=7cm

The settings dialog combines application preferences
and project setting in a compact set of six tabs.
The *Settings* dialog combines application preferences
and project settings in a compact set of six tabs.

The *General* tab contains a collection of application wide setting. They are
stored as a user preferences.
The *General* tab contains a collection of application wide settings. They are
stored as user preferences.

The *Project* tab holds settings for the current project. They are saved with
the `.fl` file.
Expand All @@ -20,15 +20,15 @@
preferences can be saved per user, or as part of the project, or exported for
use in other projects.

The *Shell* tabs manages a database of quick access shell commands and scripts.
The *Shell* tab manages a database of quick access shell commands and scripts.
Shell commands can be saved as a user preference and also as part of the
`.fl` project file.

The *Locale* tab sets the method of internationalizing texts in the project,
commonly used for labels and tooltips.

The *User* tab manages customization of fonts and colors in the widget browser.
Setting are stored as user preferences.
These settings are stored as user preferences.

<div style="clear:both;"></div>

Expand Down Expand Up @@ -82,7 +82,7 @@
the extension of the `.fl` project file name.

\todo Document the exact way the source and header file paths are calculated
for interactive FLUID, and for FLUID launched form the command line.
for interactive FLUID, and for FLUID launched from the command line.

__Include Header from Code__:

Expand All @@ -97,7 +97,7 @@

__allow Unicode__:

If unchecked, Unicode characters in string are escaped, If checked, the Unicode
If unchecked, Unicode characters in strings are escaped. If checked, the Unicode
character is stored in the source code in UTF-8 encoding.

__avoid early include__:
Expand Down Expand Up @@ -147,9 +147,9 @@

__Widget Minimum, Increment, and Gap__:

_Minimum_ set the minimal width of a widget. _Increment_ is the size multiplier
_Minimum_ sets the minimal width of a widget. _Increment_ is the size multiplier
added to the _Minimum_ value. _Gap_ is the preferred distance to other widgets
in the same group
in the same group.

__Label Font__, __Text Font__:

Expand Down Expand Up @@ -183,8 +183,8 @@
__Menu Label__:

Shell scripts that match the *Condition* flag are also available for quick
access in the *Shell* menu in the main window and via shortcut keys
combination. This is the text that is used for the menu entry.
access in the *Shell* menu in the main window and via shortcut key
combinations. This is the text that is used for the menu entry.

__Shortcut__:

Expand Down Expand Up @@ -218,7 +218,7 @@
\section setting_i18n Internationalization

The *Locale* tab can be used to configure optional internationalization.
FLUID support GNU `gettext` and Posix `catgets`.
FLUID supports GNU `gettext` and POSIX `catgets`.

FLUID supports internationalization (I18N for short) of label
strings and tooltips used by widgets. The GNU gettext option also
Expand Down
6 changes: 3 additions & 3 deletions fluid/documentation/src/page_sourceview_panel.dox
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
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 select project internationalization method.
to a translation file, using the selected project internationalization method.

The fourth tab previews the contents of the `.fl` project file.

Expand All @@ -43,7 +43,7 @@

__aA__: press this button to activate case sensitive search

__&lt;&lt;__, __&gt;&gt;__: find the previous or next occurence
__&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
Expand All @@ -59,7 +59,7 @@

__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 select code tab.
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.

Expand Down
6 changes: 3 additions & 3 deletions fluid/documentation/src/page_tutorial.dox
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@
`main()` function that opens an application window with a static text box
inside.

After launching FLUID we want to make sure that two very usefule tool windows
After launching FLUID we want to make sure that two very useful tool windows
are open.
The "Widget Bin" gives quick access to all available widgets and functional
types. It can be opened via the main menu: __Edit > Show Widget Bin__, or
using the shortcut __Alt-B__.

The second very helpful tool box is the "Code View". The Code View gives
a preview of the code as it will be generated by FLUID. All changes in the
scene graph or in attributes are reflected immediately in the Code View.
layout or in attributes are reflected immediately in the Code View.
Choose __Edit > Show Code View__ or press __Shift-Alt-S__ to get this
toolbox. Make sure that _Auto-Refresh_ and _Auto-Position_ are active in
the Code View.
Expand Down Expand Up @@ -147,7 +147,7 @@

<!-- ---------------------------------------------------------------------- -->

\section fluid_cubeview_tutorial Cube VIew
\section fluid_cubeview_tutorial Cube View

This tutorial will show you how to generate a complete user interface
class with FLUID that is used for the CubeView program provided with FLTK.
Expand Down
Loading

0 comments on commit 8929d0b

Please sign in to comment.