glimmer-dsl-libui 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602cf477d5809c99e64e46f2e51a66f1610364a28402b568cc6fe97cf5666115
-  data.tar.gz: 3a45bca62165d28c11d8f9ee9e0c281c986c499b9df9ffb889214cb4a2240974
+  metadata.gz: db236ce703f8fbdab45930d36dca47f2303faf3405fd3bd037bbcab261b79245
+  data.tar.gz: ac097ae80240402e741d38b08f8b1c5e6941582c9e2b17fadf29d5c76971419d
 SHA512:
-  metadata.gz: 696a6c43d9b75fa8692d74121d6674dc0b3a040cf47401721007ed6a4865372a67dc46df96bdf63d167a2b3b5187c3ca4139a365fa7942d537f85ed6287f8908
-  data.tar.gz: 1b9480211e41aa30fa51f3936d44b3597c5c30d535ccead178504bb7b9c3ed2f3dbc61ae838b81e2c6d2e3fe8a6e4d30a8406fdce81e800398972564699dff63
+  metadata.gz: d32551f5df4bd763f1c6cee6a52c706972658ee3507e5d619152672679a1b9f499653da26b2581d7d35cd92aa40439f956900681d5c9b8e1b233db71a32cb8bd
+  data.tar.gz: def3355ba0e07c7f72d1deede04233932cbb175e4142fe77d1e243b95eb960849e123e729f14be5d27a94a16bc4c4060d65c75df22c2c7f44cc2e87e2350db48

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.0.7
+
+- Make `padded 1` the default in `horizontal_box` and `vertical_box` to achieve nicer looking GUI by default
+- Make `margined 1` the default in `group` to achieve nicer looking GUI by default
+- Destroy main window upon hitting quit on quit menu item
+- Rename `ControlProxy::all_controls` to `ControlProxy::all_control_proxies` to more accurately describe its contents
+- Add `ControlProxy::main_window_proxy` method to retrieve main window proxy
+- Define a `#window_proxy` method on `ControlProxy` to retrieve `window` control proxy for any control
+
 ## 0.0.6
 
 - Make listener block provide Ruby proxy object as optional argument (not Fiddle pointer)

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.0.6
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.0.7
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ce2853efdbecf6ebdc73/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-libui/maintainability)
@@ -32,7 +32,7 @@ window('hello world', 300, 200, 1).show
 ![glimmer-dsl-libui-mac-basic-window.png](images/glimmer-dsl-libui-mac-basic-window.png)
 ![glimmer-dsl-libui-linux-basic-window.png](images/glimmer-dsl-libui-linux-basic-window.png)
 
-NOTE: [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is in early alpha mode (only supports included examples). Please help make better by contributing, adopting for small or low risk projects, and providing feedback. It is still an early alpha, so the more feedback and issues you report the better.
+NOTE: [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is in early alpha mode (only supports included [examples](#examples)). Please help make better by contributing, adopting for small or low risk projects, and providing feedback. It is still an early alpha, so the more feedback and issues you report the better.
 
 Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interested in:
 - [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)
@@ -43,14 +43,17 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.0.6](#-glimmer-dsl-for-libui-006)
+- [Glimmer DSL for LibUI 0.0.7](#-glimmer-dsl-for-libui-007)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
     - [Supported Controls](#supported-controls)
     - [Common Control Properties](#common-control-properties)
     - [Common Control Operations](#common-control-operations)
+    - [Extra Dialogs](#extra-dialogs)
     - [Extra Operations](#extra-operations)
+    - [Smart Defaults and Conventions](#smart-defaults-and-conventions)
+    - [Original API](#original-api)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Examples](#examples)
     - [Basic Window](#basic-window)
@@ -146,7 +149,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.6'
+gem 'glimmer-dsl-libui', '~> 0.0.7'
 ```
 
 Add `require 'glimmer-dsl-libui'` at the top, and then `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
@@ -207,10 +210,10 @@ Control(Args) | Properties | Listeners
 `combobox` | `items` (`Array` of `String`), `selected` (`1` or `0`) | `on_selected`
 `color_button` | `color` (r `Numeric`, g `Numeric`, b `Numeric`, a `Numeric`), `selected` (`1` or `0`) | `on_selected`
 `date_picker` | None | None
-`date_time_picker` | `time` (`UI::FFI::TM`) | `on_changed`
+`date_time_picker` | `time` (`LibUI::FFI::TM`) | `on_changed`
 `editable_combobox` | `items` (`Array` of `String`), `text` (`String`) | `on_changed`
 `entry` | `read_only` (`1` or `0`), `text` (`String`) | `on_changed`
-`font_button` | `font` (`UI::FFI::FontDescriptor`) | `on_changed`
+`font_button` | `font` (`LibUI::FFI::FontDescriptor`) | `on_changed`
 `group(text as String)` | `margined` (`1` or `0`), `title` (`String`) | None
 `horizontal_box` | `padded` (`1` or `0`) | None
 `horizontal_separator` | None | None
@@ -249,11 +252,31 @@ Control(Args) | Properties | Listeners
 - `hide`
 - `show`
 
-### Extra Operations
+### Extra Dialogs
+
 - `open_file(window as Glimmer::LibUI::WindowProxy)`: returns selected file (`String`) or `nil` if cancelled
 - `save_file(window as Glimmer::LibUI::WindowProxy)`: returns selected file (`String`) or `nil` if cancelled
 
-To learn more about the [LibUI](https://github.com/kojix2/LibUI) API exposed through [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui), check out the [libui C headers](https://github.com/andlabs/libui/blob/master/ui.h)
+### Extra Operations
+
+- `ControlProxy::all_control_proxies`: returns all instantiated control proxies in the application
+- `ControlProxy::main_window_proxy`: returns the first window proxy instantiated in the application
+- `ControlProxy#window_proxy`: returns the window proxy parent for a control
+
+### Smart Defaults and Conventions
+
+- `horizontal_box` and `vertical_box` controls have `padded` as `1` upon instantiation to ensure more user-friendly GUI by default
+- `group` controls have `margined` as `1` upon instantiation to ensure more user-friendly GUI by default
+- All controls nested under a `horizontal_box` or `vertical_box` have `stretchy` property (passed to `box_append` method) as `1` by default (filling maximum space)
+- `window` has an `on_closing` listener by default that quits application upon hitting the close button (can be overridden with a manual `on_closing` implementation that returns integer `0` for success)
+- `quit_menu_item` has an `on_clicked` listener by default that quits application upon selecting the quit menu item (can be overridden with a manual `on_clicked` implementation that returns integer `0` for success)
+- If an `on_closing` listener was defined on `window` and it does not return an integer, default exit behavior is assumed (`window.destroy` is called followed by `LibUI.quit`, returning `0`).
+- If an `on_clicked` listener was defined on `quit_menu_item` and it does not return an integer, default exit behavior is assumed (`main_window.destroy` is called followed by `LibUI.quit`, returning `0`).
+
+### Original API
+
+To learn more about the [LibUI](https://github.com/kojix2/LibUI) API exposed through [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui),
+check out the [libui C headers](https://github.com/andlabs/libui/blob/master/ui.h)
 
 ## Girb (Glimmer IRB)
 
@@ -1077,17 +1100,9 @@ MAIN_WINDOW = window('Control Gallery', 600, 500, 1) {
   end
   
   vertical_box {
-    padded 1
-
     horizontal_box {
-      padded 1
-
       group('Basic Controls') {
-        margined 1
-
         vertical_box {
-          padded 1
-
           button('Button') {
             stretchy 0
 
@@ -1123,15 +1138,10 @@ MAIN_WINDOW = window('Control Gallery', 600, 500, 1) {
       }
 
       vertical_box {
-        padded 1
-
         group('Numbers') {
           stretchy 0
-          margined 1
 
           vertical_box {
-            padded 1
-
             spinbox(0, 100) {
               stretchy 0
               value 42
@@ -1157,11 +1167,8 @@ MAIN_WINDOW = window('Control Gallery', 600, 500, 1) {
 
         group('Lists') {
           stretchy 0
-          margined 1
 
           vertical_box {
-            padded 1
-
             combobox {
               stretchy 0
               items 'combobox Item 1', 'combobox Item 2', 'combobox Item 3' # also accepts a single array argument

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/examples/control_gallery.rb

@@ -50,17 +50,9 @@ MAIN_WINDOW = window('Control Gallery', 600, 500, 1) {
   end
   
   vertical_box {
-    padded 1
-
     horizontal_box {
-      padded 1
-
       group('Basic Controls') {
-        margined 1
-
         vertical_box {
-          padded 1
-
           button('Button') {
             stretchy 0
 
@@ -96,15 +88,10 @@ MAIN_WINDOW = window('Control Gallery', 600, 500, 1) {
       }
 
       vertical_box {
-        padded 1
-
         group('Numbers') {
           stretchy 0
-          margined 1
 
           vertical_box {
-            padded 1
-
             spinbox(0, 100) {
               stretchy 0
               value 42
@@ -130,11 +117,8 @@ MAIN_WINDOW = window('Control Gallery', 600, 500, 1) {
 
         group('Lists') {
           stretchy 0
-          margined 1
 
           vertical_box {
-            padded 1
-
             combobox {
               stretchy 0
               items 'combobox Item 1', 'combobox Item 2', 'combobox Item 3' # also accepts a single array argument

data/lib/glimmer/libui/box.rb

@@ -32,6 +32,14 @@ module Glimmer
       def libui_api_keyword
         'box'
       end
+      
+      private
+      
+      def build_control
+        super.tap do
+          self.padded = 1
+        end
+      end
     end
   end
 end

data/lib/glimmer/libui/control_proxy.rb

@@ -33,7 +33,7 @@ module Glimmer
         end
         
         def create(keyword, parent, args, &block)
-          widget_proxy_class(keyword).new(keyword, parent, args, &block).tap {|c| all_controls << c}
+          widget_proxy_class(keyword).new(keyword, parent, args, &block).tap {|c| all_control_proxies << c}
         end
         
         def widget_proxy_class(keyword)
@@ -46,9 +46,13 @@ module Glimmer
         end
         
         # autosave all controls in this array to avoid garbage collection
-        def all_controls
-          @@all_controls = [] unless defined?(@@all_controls)
-          @@all_controls
+        def all_control_proxies
+          @@all_control_proxies = [] unless defined?(@@all_control_proxies)
+          @@all_control_proxies
+        end
+        
+        def main_window_proxy
+          all_control_proxies.find {|c| c.is_a?(WindowProxy)}
         end
       end
       
@@ -77,6 +81,14 @@ module Glimmer
       def post_initialize_child(child)
         # No Op by default
       end
+      
+      def window_proxy
+        found_proxy = self
+        until found_proxy.nil? || found_proxy.is_a?(WindowProxy)
+          found_proxy = found_proxy.parent_proxy
+        end
+        found_proxy
+      end
 
       def can_handle_listener?(listener_name)
         ::LibUI.respond_to?("#{libui_api_keyword}_#{listener_name}") ||
@@ -182,7 +194,7 @@ module Glimmer
       
       def destroy
         send_to_libui('destroy')
-        self.class.all_controls.delete(self)
+        self.class.all_control_proxies.delete(self)
       end
       
       private

data/lib/glimmer/libui/group_proxy.rb

@@ -30,6 +30,14 @@ module Glimmer
       def post_initialize_child(child)
         ::LibUI.group_set_child(@libui, child.libui)
       end
+      
+      private
+      
+      def build_control
+        super.tap do
+          self.margined = 1
+        end
+      end
     end
   end
 end

data/lib/glimmer/libui/quit_menu_item_proxy.rb

@@ -52,7 +52,7 @@ module Glimmer
       def build_control
         @libui = @parent_proxy.append_quit_item(*@args)
         handle_listener('on_clicked') do
-          destroy
+          ControlProxy.main_window_proxy&.destroy
           ::LibUI.quit
           0
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Andy Maleh