glimmer-dsl-libui 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf22d736dce460dde98ce6cb9d10d50433cce189b648b7b9f4fccd1a4e6cefc
-  data.tar.gz: 36f38bc99b47ae56d321986e9e27e3dfce18dacb3cc3f4722966c36ab329a896
+  metadata.gz: 45785cccb2a89070b2230fdae1c7418b48c6b8ac4682bf6ee0c2eb832f35bc1c
+  data.tar.gz: 0a5544bef68a214ddb4ed55eb4ff71efa5916ce8c7e2d0b1c6d8f36d5b5fbd6f
 SHA512:
-  metadata.gz: 0fcd083428bfdb29db1428012a8dab67516ea5525e37aa5bdb0c7aa0b9679b78e3a01090b8ec20ca4d799b1ea48c41b0983d2570fd12a470246bb2b7fb7eae4c
-  data.tar.gz: b5824e2efefc6ccc319a029d4f5eadd976658c3c85bac6fe993ff6da4a9eb2cd5484ccea877b8557c49e2454ac8bb77599eb12219e1eff9fffddeda2489c67ee
+  metadata.gz: '08005e8f56a310c7b534bfafde7e958617ee483985f30facf02a62a015d860a6378e4f7d5399b37fa5a247ef899a7092c313f120d5599a72d288bd3781a43820'
+  data.tar.gz: befd92a20a6bc56c19049cfc385970bd8e113ae191c45ac3c3fffb513dd9140838229b79859392aed2e452d6e235d95059fe5d7847b3ac48cc5b4261aae50b26

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.0.15
+
+- New examples/form.rb
+- Support `form` control and child attributes of `stretchy` and `label`
+- Smart defaults for `form` child attributes `stretchy` (`true`) and `label` (`''`)
+
 ## 0.0.14
 
 - New examples/grid.rb

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.14
+# [<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.15
 ## 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)
@@ -43,7 +43,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.0.14](#-glimmer-dsl-for-libui-0014)
+- [Glimmer DSL for LibUI 0.0.15](#-glimmer-dsl-for-libui-0015)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -68,6 +68,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Color Button](#color-button)
     - [Date Time Picker](#date-time-picker)
     - [Grid](#grid)
+    - [Form](#form)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -155,7 +156,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.14'
+gem 'glimmer-dsl-libui', '~> 0.0.15'
 ```
 
 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.
@@ -220,6 +221,7 @@ Control(Args) | Properties | Listeners
 `editable_combobox` | `items` (`Array` of `String`), `text` (`String`) | `on_changed`
 `entry` | `read_only` (Boolean), `text` (`String`) | `on_changed`
 `font_button` | `font` [read-only] (`Hash` of keys: `:family`, `:size`, `:weight`, `:italic`, `:stretch`), `family` as `String`, `size` as `Float`, `weight` as `Integer`, `italic` as `Integer`, `stretch` as `Integer` | `on_changed`
+`form` | `padded` (Boolean) | None
 `grid` | `padded` (Boolean) | None
 `group(text as String)` | `margined` (Boolean), `title` (`String`) | None
 `horizontal_box` | `padded` (Boolean) | None
@@ -250,7 +252,7 @@ Control(Args) | Properties | Listeners
 - `parent` (`Fiddle::Pointer`)
 - `toplevel` [read-only] (Boolean)
 - `visible` (Boolean)
-- `stretchy` [dsl-only] (Boolean) [default=`true`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `horizontal_box` or `vertical_box`
+- `stretchy` [dsl-only] (Boolean) [default=`true`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `horizontal_box`, `vertical_box`, or `form`
 - `left` [dsl-only] (`Integer`) [default=`0`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 - `top` [dsl-only] (`Integer`) [default=`0`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 - `xspan` [dsl-only] (`Integer`) [default=`1`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
@@ -280,7 +282,7 @@ Control(Args) | Properties | Listeners
 
 ### Smart Defaults and Conventions
 
-- `horizontal_box`, `vertical_box`, and `grid` controls have `padded` as `true` upon instantiation to ensure more user-friendly GUI by default
+- `horizontal_box`, `vertical_box`, `grid`, and `form` controls have `padded` as `true` upon instantiation to ensure more user-friendly GUI by default
 - `group` controls have `margined` as `true` 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 `true` by default (filling maximum space)
 - `window` constructor args can be left off and have the following defaults when unspecified: `title` as `'Glimmer'`, `width` as `150`, `height` as `150`, and `has_menubar` as `true`)
@@ -295,13 +297,14 @@ Control(Args) | Properties | Listeners
 - Automatically allocate color value pointers upon instantiating `color_button` controls and free them when destorying `color_button` controls
 - On the Mac, if no `menu` items were added, an automatic `quit_menu_item` is added to enable quitting with CTRL+Q
 - When destroying a control nested under a `horizontal_box` or `vertical_box`, it is automatically deleted from the box's children
+- When destroying a control nested under a `form`, it is automatically deleted from the form's children
 - When destroying a control nested under a `window` or `group`, it is automatically unset as their child to allow successful destruction
 - For `date_time_picker`, `date_picker`, and `time_picker`, make sure `time` hash values for `mon`, `wday`, and `yday` are 1-based instead of [libui](https://github.com/andlabs/libui) original 0-based values, and return `dst` as Boolean instead of `isdst` as `1`/`0`
 - Smart defaults for `grid` child attributes are `left` (`0`), `top` (`0`), `xspan` (`1`), `yspan` (`1`), `hexpand` (`false`), `halign` (`0`), `vexpand` (`false`), and `valign` (`0`)
 
 ### API Gotchas
 
-There is no proper was to destroy `grid` children due to [libui](https://github.com/andlabs/libui) not offering any API for deleting them from `grid` (no `grid_delete` similar to `box_delete` for `horizontal_box` and `vertical_box`)
+There is no proper way to destroy `grid` children due to [libui](https://github.com/andlabs/libui) not offering any API for deleting them from `grid` (no `grid_delete` similar to `box_delete` for `horizontal_box` and `vertical_box`)
 
 ### Original API
 
@@ -1688,6 +1691,64 @@ window('Grid') {
 }.show
 ```
 
+### Form
+
+[examples/form.rb](examples/form.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/form.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/form'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-form.png](images/glimmer-dsl-libui-mac-form.png)
+![glimmer-dsl-libui-mac-form-msg-box.png](images/glimmer-dsl-libui-mac-form-msg-box.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-form.png](images/glimmer-dsl-libui-linux-form.png)
+![glimmer-dsl-libui-linux-form-msg-box.png](images/glimmer-dsl-libui-linux-form-msg-box.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Form') { |w|
+  margined true
+  
+  vertical_box {
+    form {
+      @first_name_entry = entry {
+        # stretchy true # Smart default option for appending to form
+        label 'First Name'
+      }
+      
+      @last_name_entry = entry {
+        # stretchy true # Smart default option for appending to form
+        label 'Last Name'
+      }
+    }
+    
+    button('Display Name') {
+      on_clicked do
+        msg_box(w, 'Name', "#{@first_name_entry.text} #{@last_name_entry.text}")
+      end
+    }
+  }
+}.show
+```
+
 ## Contributing to glimmer-dsl-libui
 
 -   Check out the latest master to make sure the feature hasn't been

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/examples/form.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Form') { |w|
+  margined true
+  
+  vertical_box {
+    form {
+      @first_name_entry = entry {
+        # stretchy true # Smart default option for appending to form
+        label 'First Name'
+      }
+      
+      @last_name_entry = entry {
+        # stretchy true # Smart default option for appending to form
+        label 'Last Name'
+      }
+    }
+    
+    button('Display Name') {
+      on_clicked do
+        msg_box(w, 'Name', "#{@first_name_entry.text} #{@last_name_entry.text}")
+      end
+    }
+  }
+}.show

data/lib/glimmer/libui/form_proxy.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/libui/control_proxy'
+
+module Glimmer
+  module LibUI
+    class FormProxy < ControlProxy
+      APPEND_PROPERTIES = %w[label stretchy]
+      
+      def post_initialize_child(child)
+        child.label = '' if child.label.nil?
+        child.stretchy = true if child.stretchy.nil?
+        ::LibUI.form_append(@libui, child.label, child.libui, ControlProxy.boolean_to_integer(child.stretchy))
+        children << child
+      end
+      
+      def children
+        @children ||= []
+      end
+      
+      def destroy_child(child)
+        ::LibUI.send("form_delete", @libui, children.index(child))
+        ControlProxy.all_control_proxies.delete(child)
+      end
+      
+      private
+      
+      def build_control
+        super.tap do
+          self.padded = true
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/libui/grid_proxy.rb

@@ -36,6 +36,11 @@ module Glimmer
         child.vexpand = false if child.vexpand.nil?
         child.valign = 0 if child.valign.nil?
         ::LibUI.grid_append(@libui, child.libui, child.left, child.top, child.xspan, child.yspan, ControlProxy.boolean_to_integer(child.hexpand), child.halign, ControlProxy.boolean_to_integer(child.vexpand), child.valign)
+        children << child
+      end
+      
+      def children
+        @children ||= []
       end
       
       # Note that there is no proper destroy_child(child) method for GridProxy due to libui not offering any API for it (no grid_delete)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Andy Maleh
@@ -188,6 +188,7 @@ files:
 - examples/control_gallery.rb
 - examples/date_time_picker.rb
 - examples/font_button.rb
+- examples/form.rb
 - examples/grid.rb
 - examples/meta_example.rb
 - examples/midi_player.rb
@@ -212,6 +213,7 @@ files:
 - lib/glimmer/libui/date_time_picker_proxy.rb
 - lib/glimmer/libui/editable_combobox_proxy.rb
 - lib/glimmer/libui/font_button_proxy.rb
+- lib/glimmer/libui/form_proxy.rb
 - lib/glimmer/libui/grid_proxy.rb
 - lib/glimmer/libui/group_proxy.rb
 - lib/glimmer/libui/horizontal_box_proxy.rb