glimmer-dsl-swt 4.18.4.8 → 4.18.5.1

data/docs/reference/GLIMMER_SAMPLES.md

@@ -1,6 +1,59 @@
+- [Samples](#samples)
+  - [Hello Samples](#hello-samples)
+    - [Hello, World!](#hello-world)
+    - [Hello, Tab!](#hello-tab)
+    - [Hello, Combo!](#hello-combo)
+    - [Hello, List Single Selection!](#hello-list-single-selection)
+    - [Hello, List Multi Selection!](#hello-list-multi-selection)
+    - [Hello, Computed!](#hello-computed)
+    - [Hello, Message Box!](#hello-message-box)
+    - [Hello, Browser!](#hello-browser)
+    - [Hello, Drag and Drop!](#hello-drag-and-drop)
+    - [Hello, Menu Bar!](#hello-menu-bar)
+    - [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu)
+    - [Hello, Custom Widget!](#hello-custom-widget)
+    - [Hello, Custom Shell!](#hello-custom-shell)
+    - [Hello, Sash Form!](#hello-sash-form)
+    - [Hello, Styled Text!](#hello-styled-text)
+    - [Hello, Expand Bar!](#hello-expand-bar)
+    - [Hello, Radio!](#hello-radio)
+    - [Hello, Radio Group!](#hello-radio-group)
+    - [Hello, Group!](#hello-group)
+    - [Hello, Checkbox!](#hello-checkbox)
+    - [Hello, Checkbox Group!](#hello-checkbox-group)
+    - [Hello, Directory Dialog!](#hello-directory-dialog)
+    - [Hello, File Dialog!](#hello-file-dialog)
+    - [Hello, Date Time!](#hello-date-time)
+    - [Hello, Spinner!](#hello-spinner)
+    - [Hello, Table!](#hello-table)
+    - [Hello, Button!](#hello-button)
+    - [Hello, Link!](#hello-link)
+    - [Hello, Dialog!](#hello-dialog)
+    - [Hello, Code Text!](#hello-code-text)
+    - [Hello, Canvas!](#hello-canvas)
+    - [Hello, Canvas Animation!](#hello-canvas-animation)
+    - [Hello, Canvas Transform!](#hello-canvas-transform)
+    - [Hello, Cursor!](#hello-cursor)
+    - [Hello, Progress Bar!](#hello-progress-bar)
+    - [Hello, Tree!](#hello-tree)
+    - [Hello, Color Dialog!](#hello-color-dialog)
+    - [Hello, Font Dialog!](#hello-font-dialog)
+  - [Elaborate Samples](#elaborate-samples)
+    - [User Profile](#user-profile)
+    - [Login](#login)
+    - [Tic Tac Toe](#tic-tac-toe)
+    - [Contact Manager](#contact-manager)
+    - [Glimmer Tetris](#glimmer-tetris)
+    - [Mandelbrot Fractal](#mandelbrot-fractal)
+  - [External Samples](#external-samples)
+    - [Glimmer Calculator](#glimmer-calculator)
+    - [Gladiator](#gladiator)
+    - [Timer](#timer)
+- [License](#license)
+
 ## Samples
 
-Check the [samples](samples) directory in [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) for examples on how to write Glimmer applications. To run a sample, make sure to install the `glimmer` gem first and then use the `glimmer samples` command to run it (alternatively, you may clone the repo, follow [CONTRIBUTING.md](CONTRIBUTING.md) instructions, and run samples locally with development glimmer command: `bin/glimmer`).
+Check the [samples](/samples) directory in [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) for examples on how to write Glimmer applications. To run a sample, make sure to install the `glimmer-dsl-swt` gem first and then use the `glimmer samples` command to run it (alternatively, you may clone the repo, follow [CONTRIBUTING.md](CONTRIBUTING.md) instructions, and run samples locally with development glimmer command: `bin/glimmer`).
 
 You may run any sample via this command:
 
@@ -8,7 +61,7 @@ You may run any sample via this command:
 glimmer samples
 ```
 
-This brings up the [Glimmer Meta-Sample (The Sample of Samples)](samples/elaborate/meta_sample.rb)
+This brings up the [Glimmer Meta-Sample (The Sample of Samples)](/samples/elaborate/meta_sample.rb)
 
 ![Glimmer Meta-Sample](/images/glimmer-meta-sample.png)
 
@@ -28,7 +81,7 @@ For hello-type simple samples, check the following.
 
 Code:
 
-[samples/hello/hello_world.rb](samples/hello/hello_world.rb)
+[samples/hello/hello_world.rb](/samples/hello/hello_world.rb)
 
 ![Hello World](/images/glimmer-hello-world.png)
 
@@ -36,7 +89,7 @@ Code:
 
 Code:
 
-[samples/hello/hello_tab.rb](samples/hello/hello_tab.rb)
+[samples/hello/hello_tab.rb](/samples/hello/hello_tab.rb)
 
 ![Hello Tab English](/images/glimmer-hello-tab-english.png)
 ![Hello Tab French](/images/glimmer-hello-tab-french.png)
@@ -47,7 +100,7 @@ This sample demonstrates combo data-binding.
 
 Code:
 
-[samples/hello/hello_combo.rb](samples/hello/hello_combo.rb)
+[samples/hello/hello_combo.rb](/samples/hello/hello_combo.rb)
 
 ![Hello Combo](/images/glimmer-hello-combo.png)
 ![Hello Combo Expanded](/images/glimmer-hello-combo-expanded.png)
@@ -58,7 +111,7 @@ This sample demonstrates list single-selection data-binding.
 
 Code:
 
-[samples/hello/hello_list_single_selection.rb](samples/hello/hello_list_single_selection.rb)
+[samples/hello/hello_list_single_selection.rb](/samples/hello/hello_list_single_selection.rb)
 
 ![Hello List Single Selection](/images/glimmer-hello-list-single-selection.png)
 
@@ -68,7 +121,7 @@ This sample demonstrates list multi-selection data-binding.
 
 Code:
 
-[samples/hello/hello_list_multi_selection.rb](samples/hello/hello_list_multi_selection.rb)
+[samples/hello/hello_list_multi_selection.rb](/samples/hello/hello_list_multi_selection.rb)
 
 ![Hello List Multi Selection](/images/glimmer-hello-list-multi-selection.png)
 
@@ -78,7 +131,7 @@ This sample demonstrates computed data-binding.
 
 Code:
 
-[samples/hello/hello_computed.rb](samples/hello/hello_computed.rb)
+[samples/hello/hello_computed.rb](/samples/hello/hello_computed.rb)
 
 ![Hello Browser](/images/glimmer-hello-computed.png)
 
@@ -88,7 +141,7 @@ This sample demonstrates a `message_box` dialog.
 
 Code:
 
-[samples/hello/hello_message_box.rb](samples/hello/hello_message_box.rb)
+[samples/hello/hello_message_box.rb](/samples/hello/hello_message_box.rb)
 
 ![Hello Message Box](/images/glimmer-hello-message-box.png)
 ![Hello Message Box Dialog](/images/glimmer-hello-message-box-dialog.png)
@@ -99,7 +152,7 @@ This sample demonstrates the `browser` widget.
 
 Code:
 
-[samples/hello/hello_browser.rb](samples/hello/hello_browser.rb)
+[samples/hello/hello_browser.rb](/samples/hello/hello_browser.rb)
 
 ![Hello Browser](/images/glimmer-hello-browser.png)
 
@@ -109,7 +162,7 @@ This sample demonstrates drag and drop in Glimmer.
 
 Code:
 
-[samples/hello/hello_drag_and_drop.rb](samples/hello/hello_drag_and_drop.rb)
+[samples/hello/hello_drag_and_drop.rb](/samples/hello/hello_drag_and_drop.rb)
 
 ![Hello Drag and Drop](/images/glimmer-hello-drag-and-drop.gif)
 
@@ -119,7 +172,7 @@ This sample demonstrates menus in Glimmer, including accelerators on the Mac.
 
 Code:
 
-[samples/hello/hello_menu_bar.rb](samples/hello/hello_menu_bar.rb)
+[samples/hello/hello_menu_bar.rb](/samples/hello/hello_menu_bar.rb)
 
 ![Hello Menu Bar](/images/glimmer-hello-menu-bar.png)
 
@@ -163,7 +216,7 @@ This sample demonstrates pop up context menus in Glimmer.
 
 Code:
 
-[samples/hello/hello_pop_up_context_menu.rb](samples/hello/hello_pop_up_context_menu.rb)
+[samples/hello/hello_pop_up_context_menu.rb](/samples/hello/hello_pop_up_context_menu.rb)
 
 ![Hello Pop Up Context Menu](/images/glimmer-hello-pop-up-context-menu.png)
 ![Hello Pop Up Context Menu Popped Up](/images/glimmer-hello-pop-up-context-menu-popped-up.png)
@@ -174,7 +227,7 @@ This sample demonstrates the use of a custom widget in Glimmer.
 
 Code:
 
-[samples/hello/hello_custom_widget.rb](samples/hello/hello_custom_widget.rb)
+[samples/hello/hello_custom_widget.rb](/samples/hello/hello_custom_widget.rb)
 
 ![Hello Custom Widget](/images/glimmer-hello-custom-widget.gif)
 
@@ -184,7 +237,7 @@ This sample demonstrates the use of a custom shell (aka custom window) in Glimme
 
 Code:
 
-[samples/hello/hello_custom_shell.rb](samples/hello/hello_custom_shell.rb)
+[samples/hello/hello_custom_shell.rb](/samples/hello/hello_custom_shell.rb)
 
 ![Hello Custom Shell](/images/glimmer-hello-custom-shell.png)
 ![Hello Custom Shell Email1](/images/glimmer-hello-custom-shell-email1.png)
@@ -197,7 +250,7 @@ This sample demonstrates the use of a `sash_form` in Glimmer.
 
 Code:
 
-[samples/hello/hello_sash_form.rb](samples/hello/hello_sash_form.rb)
+[samples/hello/hello_sash_form.rb](/samples/hello/hello_sash_form.rb)
 
 Hello, Sash Form! Horizontal Orientation
 
@@ -229,7 +282,7 @@ This sample demonstrates the use of a `styled_text` in Glimmer.
 
 Code:
 
-[samples/hello/hello_styled_text.rb](samples/hello/hello_styled_text.rb)
+[samples/hello/hello_styled_text.rb](/samples/hello/hello_styled_text.rb)
 
 Hello, Styled Text!
 
@@ -241,7 +294,7 @@ This sample demonstrates the use of a `expand_bar` and `expand_item` in Glimmer.
 
 Code:
 
-[samples/hello/hello_expand_bar.rb](samples/hello/hello_expand_bar.rb)
+[samples/hello/hello_expand_bar.rb](/samples/hello/hello_expand_bar.rb)
 
 Hello, Expand Bar! All Expanded
 
@@ -265,7 +318,7 @@ This sample demonstrates the use of a `radio` (aka `button(:radio)`) in Glimmer.
 
 Code:
 
-[samples/hello/hello_radio.rb](samples/hello/hello_radio.rb)
+[samples/hello/hello_radio.rb](/samples/hello/hello_radio.rb)
 
 Hello, Radio!
 
@@ -277,7 +330,7 @@ This sample demonstrates the use of a `radio_group` in Glimmer, which provides t
 
 Code:
 
-[samples/hello/hello_radio_group.rb](samples/hello/hello_radio_group.rb)
+[samples/hello/hello_radio_group.rb](/samples/hello/hello_radio_group.rb)
 
 Hello, Radio Group!
 
@@ -289,7 +342,7 @@ This sample demonstrates the use of a `group` in Glimmer (not to be confused wit
 
 Code:
 
-[samples/hello/hello_group.rb](samples/hello/hello_group.rb)
+[samples/hello/hello_group.rb](/samples/hello/hello_group.rb)
 
 Hello, Group!
 
@@ -301,7 +354,7 @@ This sample demonstrates the use of a `checkbox` (aka `check` or `button(:check)
 
 Code:
 
-[samples/hello/hello_checkbox.rb](samples/hello/hello_checkbox.rb)
+[samples/hello/hello_checkbox.rb](/samples/hello/hello_checkbox.rb)
 
 Hello, Checkbox!
 
@@ -313,7 +366,7 @@ This sample demonstrates the use of a `checkbox_group` (aka `check_group`) in Gl
 
 Code:
 
-[samples/hello/hello_checkbox_group.rb](samples/hello/hello_checkbox_group.rb)
+[samples/hello/hello_checkbox_group.rb](/samples/hello/hello_checkbox_group.rb)
 
 Hello, Checkbox Group!
 
@@ -325,7 +378,7 @@ This sample demonstrates the use of a `directory_dialog` in Glimmer.
 
 Code:
 
-[samples/hello/hello_directory_dialog.rb](samples/hello/hello_directory_dialog.rb)
+[samples/hello/hello_directory_dialog.rb](/samples/hello/hello_directory_dialog.rb)
 
 Hello, Directory Dialog!
 
@@ -345,7 +398,7 @@ This sample demonstrates the use of a `file_dialog` in Glimmer.
 
 Code:
 
-[samples/hello/hello_file_dialog.rb](samples/hello/hello_file_dialog.rb)
+[samples/hello/hello_file_dialog.rb](/samples/hello/hello_file_dialog.rb)
 
 Hello, File Dialog!
 
@@ -365,7 +418,7 @@ This sample demonstrates the use of [date_time](#datetime) widget keywords in Gl
 
 Code:
 
-[samples/hello/hello_date_time.rb](samples/hello/hello_date_time.rb)
+[samples/hello/hello_date_time.rb](/samples/hello/hello_date_time.rb)
 
 Hello, Date Time!
 
@@ -377,7 +430,7 @@ This sample demonstrates the use of `spinner` widget in Glimmer
 
 Code:
 
-[samples/hello/hello_spinner.rb](samples/hello/hello_spinner.rb)
+[samples/hello/hello_spinner.rb](/samples/hello/hello_spinner.rb)
 
 Hello, Spinner!
 
@@ -389,7 +442,7 @@ This sample demonstrates the use of [table](#table) widget in Glimmer, including
 
 Code:
 
-[samples/hello/hello_table.rb](samples/hello/hello_table.rb)
+[samples/hello/hello_table.rb](/samples/hello/hello_table.rb)
 
 Hello, Table!
 
@@ -437,7 +490,7 @@ This sample demonstrates the use of the `button` widget in Glimmer, including da
 
 Code:
 
-[samples/hello/hello_button.rb](samples/hello/hello_button.rb)
+[samples/hello/hello_button.rb](/samples/hello/hello_button.rb)
 
 Hello, Button!
 
@@ -453,7 +506,7 @@ This sample demonstrates the use of the `link` widget in Glimmer, including iden
 
 Code:
 
-[samples/hello/hello_link.rb](samples/hello/hello_link.rb)
+[samples/hello/hello_link.rb](/samples/hello/hello_link.rb)
 
 Hello, Link!
 
@@ -469,7 +522,7 @@ This sample demonstrates the use of the `dialog` widget in Glimmer, which provid
 
 Code:
 
-[samples/hello/hello_dialog.rb](samples/hello/hello_dialog.rb)
+[samples/hello/hello_dialog.rb](/samples/hello/hello_dialog.rb)
 
 Hello, Dialog!
 
@@ -485,7 +538,7 @@ This sample demonstrates the Glimmer Built-In [Code Text Custom Widget](#code-te
 
 Code:
 
-[samples/hello/hello_code_text.rb](samples/hello/hello_code_text.rb)
+[samples/hello/hello_code_text.rb](/samples/hello/hello_code_text.rb)
 
 Hello, Code Text! Ruby Language / Glimmer Theme / Show Line Numbers (default width of 4)
 
@@ -505,19 +558,35 @@ This sample demonstrates the use of the `canvas` widget and [Shape DSL](#canvas-
 
 Code:
 
-[samples/hello/hello_canvas.rb](samples/hello/hello_canvas.rb)
+[samples/hello/hello_canvas.rb](/samples/hello/hello_canvas.rb)
 
 Hello, Canvas!
 
 ![Hello Canvas](/images/glimmer-hello-canvas.png)
 
+Hello, Canvas! with Moved Shapes (via Drag'n'Drop)
+
+![Hello Canvas Moved Shapes](/images/glimmer-hello-canvas-moved-shapes.png)
+
+Hello, Canvas! Menu (for background/foreground color changes)
+
+![Hello Canvas Menu](/images/glimmer-hello-canvas-menu.png)
+
+Hello, Canvas! Color Dialog
+
+![Hello Canvas Color Dialog](/images/glimmer-hello-canvas-color-dialog.png)
+
+Hello, Canvas! Colors Changed
+
+![Hello Canvas Colors Changed](/images/glimmer-hello-canvas-colors-changed.png)
+
 #### Hello, Canvas Animation!
 
 This sample demonstrates the use of the `canvas` widget and [Animation DSL](#canvas-animation-dsl) in Glimmer.
 
 Code:
 
-[samples/hello/hello_canvas_animation.rb](samples/hello/hello_canvas_animation.rb)
+[samples/hello/hello_canvas_animation.rb](/samples/hello/hello_canvas_animation.rb)
 
 Hello, Canvas Animation!
 
@@ -533,12 +602,83 @@ This sample demonstrates the use of the `transform` keyword as part of the [Tran
 
 Code:
 
-[samples/hello/hello_canvas_transform.rb](samples/hello/hello_canvas_transform.rb)
+[samples/hello/hello_canvas_transform.rb](/samples/hello/hello_canvas_transform.rb)
 
 Hello, Canvas Transform!
 
 ![Hello Canvas Transform](/images/glimmer-hello-canvas-transform.png)
 
+#### Hello, Cursor!
+
+This sample demonstrates the use of the `cursor` property keyword to change the mouse cursor.
+
+Code:
+
+[samples/hello/hello_cursor.rb](/samples/hello/hello_cursor.rb)
+
+Hello, Cursor!
+
+![Hello Cursor](/images/glimmer-hello-cursor.gif)
+
+#### Hello, Progress Bar!
+
+This sample demonstrates the use of the `progress_bar` widget keyword.
+
+It includes an `:indeterminate` progress bar on top, for cases when you could not calculate progress, but still want to inform the user there is an operation happening in the background.
+
+Below it, there are a determinate `:horizontal` (default) progress bar and a `:vertical` progress bar.
+
+Code:
+
+[samples/hello/hello_progress_bar.rb](/samples/hello/hello_progress_bar.rb)
+
+Hello, Progress Bar!
+
+![Hello Progress Bar](/images/glimmer-hello-progress-bar.gif)
+
+#### Hello, Tree!
+
+This sample demonstrates the use of the `tree` widget along with tree data-binding.
+
+Code:
+
+[samples/hello/hello_tree.rb](/samples/hello/hello_tree.rb)
+
+Hello, Tree!
+
+![Hello Tree](/images/glimmer-hello-tree.png)
+
+#### Hello, Color Dialog!
+
+This sample demonstrates the use of the `color_dialog` keyword.
+
+Code:
+
+[samples/hello/hello_color_dialog.rb](/samples/hello/hello_color_dialog.rb)
+
+Hello, Color Dialog!
+
+![Hello Color Dialog](/images/glimmer-hello-color-dialog.png)
+
+![Hello Color Dialog Choose Color](/images/glimmer-hello-color-dialog-choose-color.png)
+
+![Hello Color Dialog Color Changed](/images/glimmer-hello-color-dialog-color-changed.png)
+
+#### Hello, Font Dialog!
+
+This sample demonstrates the use of the `font_dialog` keyword.
+
+Code:
+
+[samples/hello/hello_font_dialog.rb](/samples/hello/hello_font_dialog.rb)
+
+Hello, Font Dialog!
+
+![Hello Font Dialog](/images/glimmer-hello-font-dialog.png)
+
+![Hello Font Dialog Choose Font](/images/glimmer-hello-font-dialog-choose-font.png)
+
+![Hello Font Dialog Font Changed](/images/glimmer-hello-font-dialog-font-changed.png)
 
 ### Elaborate Samples
 
@@ -552,7 +692,7 @@ Please note that the code has changed since that article was written (the GUI DS
 
 Code:
 
-[samples/elaborate/user_profile.rb](samples/elaborate/user_profile.rb)
+[samples/elaborate/user_profile.rb](/samples/elaborate/user_profile.rb)
 
 ![User Profile](/images/glimmer-user-profile.png)
 
@@ -562,7 +702,7 @@ This sample demonstrates basic data-binding, password and text fields, and field
 
 Code:
 
-[samples/elaborate/login.rb](samples/elaborate/login.rb)
+[samples/elaborate/login.rb](/samples/elaborate/login.rb)
 
 ![Login](/images/glimmer-login.png)
 ![Login Filled In](/images/glimmer-login-filled-in.png)
@@ -576,7 +716,7 @@ Code:
 
 (Please note that on some Linux instances where the display x-axis is set to double-scale, you need to set the `shell` `minimum_size` to `300, 178` instead of `150, 178`)
 
-[samples/elaborate/tic_tac_toe.rb](samples/elaborate/tic_tac_toe.rb)
+[samples/elaborate/tic_tac_toe.rb](/samples/elaborate/tic_tac_toe.rb)
 
 ![Tic Tac Toe](/images/glimmer-tic-tac-toe.png)
 ![Tic Tac Toe In Progress](/images/glimmer-tic-tac-toe-in-progress.png)
@@ -588,7 +728,7 @@ This sample demonstrates table data-binding, sorting, filtering, GUI layout, MVP
 
 Code:
 
-[samples/elaborate/contact_manager.rb](samples/elaborate/contact_manager.rb)
+[samples/elaborate/contact_manager.rb](/samples/elaborate/contact_manager.rb)
 
 Contact Manager
 
@@ -618,7 +758,7 @@ Note that it works optimally on the Mac. It is very new, so it has not been opti
 
 Code:
 
-[samples/elaborate/tetris.rb](samples/elaborate/tetris.rb)
+[samples/elaborate/tetris.rb](/samples/elaborate/tetris.rb)
 
 ![Tetris Icon](/images/glimmer-tetris-icon.png)
 
@@ -638,6 +778,32 @@ Code:
 
 ![Tetris Help Menu](/images/glimmer-tetris-help-menu.png)
 
+#### Mandelbrot Fractal
+
+This sample demonstrates how to render canvas graphics with multi-threaded processing taking advantage of all CPU cores and doing background processing of images.
+
+It renders the famous Mandelbrot Fractal, enabling zooming and panning (go to Help -> Instructions for more details)
+
+The Mandelbrot Fractal is known to take a long time to render, but thanks to multi-core processing, the app starts in about 10 seconds with 4 CPU cores (runs faster the more cores you have)
+
+Lower the cores in the menu to get more responsive interaction (e.g. zooming/panning). Once you change the cores, the change will not take effect till the next zoom calculation cycle.
+
+Code:
+
+[samples/elaborate/mandelbrot_fractal.rb](/samples/elaborate/mandelbrot_fractal.rb)
+
+![Mandelbrot Fractal Zoom 1](/images/glimmer-mandelbrot-zoom1.png)
+
+![Mandelbrot Fractal Zoom 3](/images/glimmer-mandelbrot-zoom3.png)
+
+![Mandelbrot Fractal Zoom 5](/images/glimmer-mandelbrot-zoom5.png)
+
+![Mandelbrot Fractal View Menu](/images/glimmer-mandelbrot-menu-view.png)
+
+![Mandelbrot Fractal Cores Menu](/images/glimmer-mandelbrot-menu-cores.png)
+
+![Mandelbrot Fractal Help Menu](/images/glimmer-mandelbrot-menu-help.png)
+
 ### External Samples
 
 #### Glimmer Calculator
@@ -648,7 +814,7 @@ Code:
 
 #### Gladiator
 
-[<img src='https://raw.githubusercontent.com/AndyObtiva/glimmer-cs-gladiator/master/images/glimmer-cs-gladiator-logo.svg' height=40 /> Gladiator](https://github.com/AndyObtiva/glimmer-cs-gladiator) (short for Glimmer Editor) is a Glimmer sample project under on-going development.
+[<img src='https://raw.githubusercontent.com/AndyObtiva/glimmer-cs-gladiator/master/images/glimmer-cs-gladiator-logo.png' height=40 /> Gladiator](https://github.com/AndyObtiva/glimmer-cs-gladiator) (short for Glimmer Editor) is a Glimmer sample project under on-going development.
 You may check it out to learn how to build a Glimmer Custom Shell gem.
 
 [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer-cs-gladiator/master/images/glimmer-gladiator.png" />](https://github.com/AndyObtiva/glimmer-cs-gladiator)