Merge pull request #100 from boydm/boyd

Document remaining styles

Author: boydm

lib/scenic/primitive/style/scissor.ex

@@ -4,7 +4,25 @@
 #
 
 defmodule Scenic.Primitive.Style.Scissor do
-  @moduledoc false
+  @moduledoc """
+  Define a "Scissor Rectangle" that drawing will be clipped to.
+
+  Example:
+
+      graph
+      |> triangle( {{0,40},{40,40},{40,0}}
+        miter_limit: 2,
+        fill: :green,
+        scissor: {20, 40}
+      )
+
+  ## Data
+
+  `{width, height}`
+
+  * `width` - Width of the scissor rectangle.
+  * `height` - Height of the scissor rectangle.
+  """
 
   use Scenic.Primitive.Style
 

lib/scenic/primitive/style/stroke.ex

@@ -4,7 +4,24 @@
 #
 
 defmodule Scenic.Primitive.Style.Stroke do
-  @moduledoc false
+  @moduledoc """
+  Draw an outline around a primitive with the given paint.
+
+  Example:
+
+      graph
+      |> triangle( {{0,40},{40,40},{40,0}}
+        miter_limit: 2,
+        stroke: {2, :green}
+      )
+
+  ## Data
+
+  `{width, paint}`
+
+  * `width` - Width of the border being stroked.
+  * `:paint` - Any [valid paint](Scenic.Primitive.Style.Paint.html).
+  """
 
   use Scenic.Primitive.Style
   alias Scenic.Primitive.Style.Paint

lib/scenic/primitive/style/text_align.ex

@@ -4,7 +4,33 @@
 #
 
 defmodule Scenic.Primitive.Style.TextAlign do
-  @moduledoc false
+  @moduledoc """
+  Set the alignment of the text with regard to the start point.
+
+  Example:
+
+      graph
+      |> text( "Some Text" text_align: :center_middle )
+
+  ## Data
+
+  `alignment`
+
+  The alignment type can be any one of the following
+
+  * `left` - Left side horizontally. Base of the text vertically.
+  * `:right` - Right side horizontally. Base of the text vertically.
+  * `:center` - Centered horizontally. Base of the text vertically.
+  * `left_top` - Left side horizontally. Top of the text vertically.
+  * `:right_top` - Right side horizontally. Top of the text vertically.
+  * `:center_top` - Centered horizontally. Top of the text vertically.
+  * `left_middle` - Left side horizontally. Centered vertically.
+  * `:right_middle` - Right side horizontally. Centered vertically.
+  * `:center_middle` - Centered horizontally. Centered vertically.
+  * `left_bottom` - Left side horizontally. Bottom of the text vertically.
+  * `:right_bottom` - Right side horizontally. Bottom of the text vertically.
+  * `:center_bottom` - Centered horizontally. Bottom of the text vertically.
+  """
 
   use Scenic.Primitive.Style
   #  alias Scenic.Primitive.Style

lib/scenic/primitive/style/text_height.ex

@@ -4,7 +4,23 @@
 #
 
 defmodule Scenic.Primitive.Style.TextHeight do
-  @moduledoc false
+  @moduledoc """
+  Set the vertical spacing of lines of text in a single block.
+
+  Example:
+
+      graph
+      |> text( "Some Text\\r\\nMore Text" text_height: 50 )
+
+  The natural vertical spacing of the font is used by default. Set this style if
+  you want to override it.
+
+  ## Data
+
+  `spacing`
+
+  * `spacing` - Vertical spacing from line to line.
+  """
 
   use Scenic.Primitive.Style
   #  alias Scenic.Primitive.Style

lib/scenic/primitive/style/theme.ex

@@ -12,6 +12,27 @@ defmodule Scenic.Primitive.Style.Theme do
 
   Unlike other styles, these are a guide to the components.
   Each component gets to pick, choose, or ignore any colors in a given style.
+
+  ## Main Predefined Themes
+  * `:dark` - This is the default and most common. Use when the background is dark.
+  * `:light` - Use when the background is light colored.
+
+  ## Specialty Themes
+
+  The remaining themes are designed to color the standard components and don't really
+  make much sense when applied to the root of a graph. You could, but it would be...
+  interesting.
+
+  The most obvious place to use them is with [`Button`](Scenic.Component.Button.html)
+  components.
+
+  * `:primary` - Blue background. This is the primary button type indicator.
+  * `:secondary` - Grey background. Not primary type indicator.
+  * `:success` - Green background.
+  * `:danger` - Red background. Use for irreversible or dangerous actions.
+  * `:warning` - Orange background.
+  * `:info` - Lightish blue background.
+  * `:text` - Transparent background.
   """
 
   use Scenic.Primitive.Style

lib/scenic/view_port.ex

@@ -356,15 +356,19 @@ defmodule Scenic.ViewPort do
           root_config: root_config,
           root_scene_pid: root_scene_pid,
           root_graph_key: root_graph_key,
-          size: size
+          size: size,
+          master_styles: styles,
+          master_transforms: transforms
         } = state
       ) do
     status = %ViewPort.Status{
       root_scene_pid: root_scene_pid,
       root_config: root_config,
       root_graph: root_graph_key,
       drivers: driver_registry,
-      size: size
+      size: size,
+      styles: styles,
+      transforms: transforms
     }
 
     {:reply, {:ok, status}, state}
@@ -434,6 +438,7 @@ defmodule Scenic.ViewPort do
       max_depth: config.max_depth,
       on_close: on_close,
       master_styles: styles,
+      master_transforms: transforms,
       master_graph: master_graph,
       master_graph_key: master_graph_key
     }

lib/scenic/view_port/status.ex

@@ -10,13 +10,21 @@ defmodule Scenic.ViewPort.Status do
   alias Scenic.ViewPort.Status
   alias Scenic.Math
 
-  defstruct drivers: nil, root_config: nil, root_graph: nil, root_scene_pid: nil, size: nil
+  defstruct drivers: nil,
+            root_config: nil,
+            root_graph: nil,
+            root_scene_pid: nil,
+            size: nil,
+            styles: %{},
+            transforms: %{}
 
   @type t :: %Status{
           drivers: map,
           root_config: {scene_module :: atom, args :: any} | (scene_name :: atom),
           root_graph: {:graph, reference, any},
           root_scene_pid: pid,
-          size: Math.point()
+          size: Math.point(),
+          styles: map,
+          transforms: map
         }
 end

test/scenic/view_port_test.exs

@@ -234,7 +234,9 @@ defmodule Scenic.ViewPortTest do
           root_config: :root_config,
           root_scene_pid: :root_scene_pid,
           root_graph_key: :root_graph_key,
-          size: :size
+          size: :size,
+          master_styles: %{},
+          master_transforms: %{}
         }
       )
 
@@ -243,6 +245,8 @@ defmodule Scenic.ViewPortTest do
     assert info.root_scene_pid == :root_scene_pid
     assert info.root_config == :root_config
     assert info.size == :size
+    assert info.styles == %{}
+    assert info.transforms == %{}
   end
 
   # ============================================================================