glimmer-dsl-libui 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19ebb3b2df3f14388664e392c4fbac8b121c6adf5638e78ddf308c7455c76c02
-  data.tar.gz: a631ed4518643c2d05ff39568f3fad815aa8729b01e1ee45ace9162bc9cf93be
+  metadata.gz: daf22d736dce460dde98ce6cb9d10d50433cce189b648b7b9f4fccd1a4e6cefc
+  data.tar.gz: 36f38bc99b47ae56d321986e9e27e3dfce18dacb3cc3f4722966c36ab329a896
 SHA512:
-  metadata.gz: 9e0fccb89ce28c472c65cabc9ff1a6044cb19c3277e960e726ea7f642ccc2861f12b6c4ec1d31a562f7d05ce64a92dcb5696a544b9dd4a2ebad25e2cd82dd61b
-  data.tar.gz: 4429a478c94b4105c079ddcda93b247271bae083a5b6c3b91e9c76c895a3273b27fced8d37262555b5139a0a19c98e63224eee3eb9ac44d89d379db151fa72ae
+  metadata.gz: 0fcd083428bfdb29db1428012a8dab67516ea5525e37aa5bdb0c7aa0b9679b78e3a01090b8ec20ca4d799b1ea48c41b0983d2570fd12a470246bb2b7fb7eae4c
+  data.tar.gz: b5824e2efefc6ccc319a029d4f5eadd976658c3c85bac6fe993ff6da4a9eb2cd5484ccea877b8557c49e2454ac8bb77599eb12219e1eff9fffddeda2489c67ee

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.0.14
+
+- New examples/grid.rb
+- Support `grid` control and child attributes of `left`, `top`, `xspan`, `yspan`, `hexpand`, `halign`, `vexpand`, and `valign`
+- Smart defaults for `grid` child attributes `left` (`0`), `top` (`0`), `xspan` (`1`), `yspan` (`1`), `hexpand` (`false`), `halign` (`0`), `vexpand` (`false`), and `valign` (`0`)
+
 ## 0.0.13
 
 - Support examples/date_time_picker.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.13
+# [<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
 ## 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.13](#-glimmer-dsl-for-libui-0013)
+- [Glimmer DSL for LibUI 0.0.14](#-glimmer-dsl-for-libui-0014)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -53,6 +53,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Extra Dialogs](#extra-dialogs)
     - [Extra Operations](#extra-operations)
     - [Smart Defaults and Conventions](#smart-defaults-and-conventions)
+    - [API Gotchas](#api-gotchas)
     - [Original API](#original-api)
   - [Glimmer Style Guide](#glimmer-style-guide)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
@@ -66,6 +67,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Font Button](#font-button)
     - [Color Button](#color-button)
     - [Date Time Picker](#date-time-picker)
+    - [Grid](#grid)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -153,7 +155,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.13'
+gem 'glimmer-dsl-libui', '~> 0.0.14'
 ```
 
 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.
@@ -218,6 +220,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`
+`grid` | `padded` (Boolean) | None
 `group(text as String)` | `margined` (Boolean), `title` (`String`) | None
 `horizontal_box` | `padded` (Boolean) | None
 `horizontal_separator` | None | None
@@ -247,7 +250,15 @@ Control(Args) | Properties | Listeners
 - `parent` (`Fiddle::Pointer`)
 - `toplevel` [read-only] (Boolean)
 - `visible` (Boolean)
-- `stretchy` [dsl-only] (Boolean): 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` or `vertical_box`
+- `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`
+- `yspan` [dsl-only] (`Integer`) [default=`1`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
+- `hexpand` [dsl-only] (Boolean) [default=`false`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
+- `halign` [dsl-only] (`Integer`) [default=`0`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
+- `vexpand` [dsl-only] (Boolean) [default=`false`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
+- `valign` [dsl-only] (`Integer`) [default=`0`]: available in [Glimmer GUI DSL](#glimmer-gui-dsl-concepts) when nested under `grid`
 
 ### Common Control Operations
 - `destroy`
@@ -269,7 +280,7 @@ Control(Args) | Properties | Listeners
 
 ### Smart Defaults and Conventions
 
-- `horizontal_box` and `vertical_box` controls have `padded` as `true` upon instantiation to ensure more user-friendly GUI by default
+- `horizontal_box`, `vertical_box`, and `grid` 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`)
@@ -286,6 +297,11 @@ Control(Args) | Properties | Listeners
 - 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 `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`)
 
 ### Original API
 
@@ -1548,7 +1564,7 @@ UI.main
 UI.quit
 ```
 
-New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
 
 ```ruby
 require 'glimmer-dsl-libui'
@@ -1571,6 +1587,107 @@ window('Date Time Pickers', 300, 200) {
 }.show
 ```
 
+### Grid
+
+[examples/grid.rb](examples/grid.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/grid.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/grid'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-grid-spanning.png](images/glimmer-dsl-libui-mac-grid-spanning.png)
+![glimmer-dsl-libui-mac-grid-expanding.png](images/glimmer-dsl-libui-mac-grid-expanding.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-grid-spanning.png](images/glimmer-dsl-libui-linux-grid-spanning.png)
+![glimmer-dsl-libui-linux-grid-expanding.png](images/glimmer-dsl-libui-linux-grid-expanding.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Grid') {
+  tab {
+    tab_item('Spanning') {
+      grid {
+        4.times { |left_value|
+          4.times { |top_value|
+            label("(#{left_value}, #{top_value}) xspan1\nyspan1") {
+              left left_value
+              top top_value
+              hexpand true
+              vexpand true
+            }
+          }
+        }
+        label("(0, 4) xspan2\nyspan1 more text fits horizontally") {
+          left 0
+          top 4
+          xspan 2
+        }
+        label("(2, 4) xspan2\nyspan1 more text fits horizontally") {
+          left 2
+          top 4
+          xspan 2
+        }
+        label("(0, 5) xspan1\nyspan2\nmore text\nfits vertically") {
+          left 0
+          top 5
+          yspan 2
+        }
+        label("(0, 7) xspan1\nyspan2\nmore text\nfits vertically") {
+          left 0
+          top 7
+          yspan 2
+        }
+        label("(1, 5) xspan3\nyspan4 a lot more text fits horizontally than before\nand\neven\na lot\nmore text\nfits vertically\nthan\nbefore") {
+          left 1
+          top 5
+          xspan 3
+          yspan 4
+        }
+      }
+    }
+    tab_item('Expanding') {
+      grid {
+        label("(0, 0) hexpand/vexpand\nall available horizontal space is taken\nand\nall\navailable\nvertical\nspace\nis\ntaken") {
+          left 0
+          top 0
+          hexpand true
+          vexpand true
+        }
+        label("(1, 0)") {
+          left 1
+          top 0
+        }
+        label("(0, 1)") {
+          left 0
+          top 1
+        }
+        label("(1, 1)") {
+          left 1
+          top 1
+        }
+      }
+    }
+  }
+}.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.13
+0.0.14

data/examples/grid.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Grid') {
+  tab {
+    tab_item('Spanning') {
+      grid {
+        4.times { |left_value|
+          4.times { |top_value|
+            label("(#{left_value}, #{top_value}) xspan1\nyspan1") {
+              left left_value
+              top top_value
+              hexpand true
+              vexpand true
+            }
+          }
+        }
+        label("(0, 4) xspan2\nyspan1 more text fits horizontally") {
+          left 0
+          top 4
+          xspan 2
+        }
+        label("(2, 4) xspan2\nyspan1 more text fits horizontally") {
+          left 2
+          top 4
+          xspan 2
+        }
+        label("(0, 5) xspan1\nyspan2\nmore text\nfits vertically") {
+          left 0
+          top 5
+          yspan 2
+        }
+        label("(0, 7) xspan1\nyspan2\nmore text\nfits vertically") {
+          left 0
+          top 7
+          yspan 2
+        }
+        label("(1, 5) xspan3\nyspan4 a lot more text fits horizontally than before\nand\neven\na lot\nmore text\nfits vertically\nthan\nbefore") {
+          left 1
+          top 5
+          xspan 3
+          yspan 4
+        }
+      }
+    }
+    tab_item('Expanding') {
+      grid {
+        label("(0, 0) hexpand/vexpand\nall available horizontal space is taken\nand\nall\navailable\nvertical\nspace\nis\ntaken") {
+          left 0
+          top 0
+          hexpand true
+          vexpand true
+        }
+        label("(1, 0)") {
+          left 1
+          top 0
+        }
+        label("(0, 1)") {
+          left 0
+          top 1
+        }
+        label("(1, 1)") {
+          left 1
+          top 1
+        }
+      }
+    }
+  }
+}.show

data/lib/glimmer/libui/grid_proxy.rb

@@ -0,0 +1,52 @@
+# 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 GridProxy < ControlProxy
+      APPEND_PROPERTIES = %w[left top xspan yspan hexpand halign vexpand valign]
+      
+      def post_initialize_child(child)
+        child.left = 0 if child.left.nil?
+        child.top = 0 if child.top.nil?
+        child.xspan = 1 if child.xspan.nil?
+        child.yspan = 1 if child.yspan.nil?
+        child.hexpand = false if child.hexpand.nil?
+        child.halign = 0 if child.halign.nil?
+        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)
+      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)
+      
+      private
+      
+      def build_control
+        super.tap do
+          self.padded = true
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Andy Maleh
@@ -188,6 +188,7 @@ files:
 - examples/control_gallery.rb
 - examples/date_time_picker.rb
 - examples/font_button.rb
+- examples/grid.rb
 - examples/meta_example.rb
 - examples/midi_player.rb
 - examples/simple_notepad.rb
@@ -211,6 +212,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/grid_proxy.rb
 - lib/glimmer/libui/group_proxy.rb
 - lib/glimmer/libui/horizontal_box_proxy.rb
 - lib/glimmer/libui/menu_item_proxy.rb