static/manual-en.txt in green_shoes-0.243.0 vs static/manual-en.txt in green_shoes-0.255.0
- old
+ new
@@ -574,12 +574,10 @@
* [[Colors The Colors list]] - a chart of all built-in colors and the [[Built-in.rgb]] numbers for each.
If you find yourself paging around a lot and not finding something, give the
[[Search]] page a try. It's the quickest way to get around.
-'''Note:''' Green Shoes doesn't support Search page so far.
-
After this general reference, there are two other more specific sections:
* [[Slots]] - covering [[Element.stack]] and [[Element.flow]], the two types of slots.
* [[Elements]] - documentation for all the buttons, shapes, images, and so on.
@@ -1026,12 +1024,10 @@
=== location() » a string ===
Gets a string containing the URL of the current app.
-'''Note:''' Green Shoes doesn't support location method so far.
-
=== mouse() » an array of numbers: button, left, top ===
Identifies the mouse cursor's location, along with which button is being
pressed.
@@ -1050,12 +1046,10 @@
Gets the app which launched this app. In most cases, this will be `nil`. But
if this app was launched using the [[Element.window]] method, the owner will be
the app which called `window`.
-'''Note:''' Green Shoes doesn't support owner method so far.
-
=== started?() » true or false ===
Has the window been fully constructed and displayed? This is useful for
threaded code which may try to use the window before it is completely built.
(Also see the `start` event which fires once the window is open.)
@@ -1192,17 +1186,15 @@
'''Note:''' Green Shoes doesn't support `:bottom` style.
=== :cap » :curve or :rect or :project ===
-For: ''arc, arrow, border, flow, image, mask, rect, star, shape, stack''.
+For: ''arc, line, shape''.
Sets the shape of the line endpoint, whether curved or square. See the
[[Art.cap]] method for more explanation.
-'''Note:''' Green Shoes doesn't support `:cap` style.
-
=== :center » true or false ===
For: ''arc, image, oval, rect, shape''.
Indicates whether the `:top` and `:left` coordinates refer to the center of the
@@ -1216,12 +1208,10 @@
For: ''edit_box, edit_line, list_box''.
The `change` event handler is stored in this style. See the [[EditBox.change]]
method for the edit_box, as an example.
-'''Note:''' Green Shoes doesn't support `:change` style.
-
=== :checked » true or false ===
For: ''check, radio''.
Is this checkbox or radio button checked? If set to `true`, the box is
@@ -1234,19 +1224,16 @@
Sets the currently chosen item in the list. More information at
[[ListBox.choose]].
=== :click » a proc ===
-For: ''arc, arrow, banner, button, caption, check, flow, image, inscription,
-line, link, mask, oval, para, radio, rect, shape, stack, star, subtitle,
-tagline, title''.
+For: ''arc, arrow, button, check, flow, image,
+line, link, oval, radio, rect, shape, stack, star''.
The `click` event handler is stored in this style. See the [[Events.click]]
method for a description.
-'''Note:''' Green Shoes doesn't support `:click` style.
-
=== :curve » a number ===
For: ''background, border, rect''.
The radius of curved corners on each of these rectangular elements. As an
@@ -1277,33 +1264,27 @@
'''Note:''' Green Shoes doesn't support `:displace_top` style.
=== :emphasis » a string ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
Styles the text with an emphasis (commonly italicized.)
This style recognizes three possible settings:
* "normal" - the font is upright.
* "oblique" - the font is slanted, but in a roman style.
* "italic" - the font is slanted in an italic style.
-'''Note:''' Green Shoes doesn't support `:emphasis` style.
-
=== :family » a string ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
Styles the text with a given font family. The string should contain the family
name or a comma-separated list of families.
-'''Note:''' Green Shoes doesn't support `:family` style.
-
=== :fill » a hex code, a rgb array or a range of either ===
For: ''background, banner, border, caption, inscription, para, line, oval,
rect, shape, star, subtitle, tagline, title''.
@@ -1391,17 +1372,14 @@
The list of selections in the list box. See the [[Element.list_box]] method
for an example.
=== :justify » true or false ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''
+For: ''banner, caption, inscription, para, subtitle, tagline, title''.
Evenly spaces the text horizontally.
-'''Note:''' Green Shoes doesn't support `:justify` style.
-
=== :kerning » a number ===
For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
strong, sub, sup, subtitle, tagline, title''.
@@ -1413,12 +1391,10 @@
For: ''banner, caption, inscription, para, subtitle, tagline, title''.
Sets the spacing between lines in a text block. Defaults to 4 pixels.
-'''Note:''' Green Shoes doesn't support `:leading` style.
-
=== :left » a number ===
For: ''all slots and elements''.
Sets the left coordinate of this object to a specific pixel. Setting `left: 10`
@@ -1496,19 +1472,16 @@
'''Note:''' Green Shoes doesn't support `:right` style.
=== :rise » a number ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
Lifts or plunges the font baseline for some text. For example, a
[[Element.sup]] has a `:rise` of 10 pixels. Conversely, the [[Element.sub]]
element has a `:rise` of -10 pixels.
-'''Note:''' Green Shoes doesn't support `:rise` style.
-
=== :scroll » true or false ===
For: ''flow, stack''.
Establishes this slot as a scrolling slot. If `:scroll => true` is set, the
@@ -1541,12 +1514,10 @@
Used for password fields, this setting keeps any characters typed in from
becoming visible on the screen. Instead, a replacement character (such as an
asterisk) is show for each letter typed.
-'''Note:''' Green Shoes doesn't support `:secret` style.
-
=== :size » a number ===
For: ''banner, caption, inscription, para, subtitle, tagline, title''.
Sets the pixel size for the font used inside this text block.
@@ -1593,29 +1564,23 @@
'''Note:''' Green Shoes doesn't support `:stretch` style.
=== :strikecolor » a Shoes::Color ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
The color used to paint any lines stricken through this text.
-'''Note:''' Green Shoes doesn't support `:strikecolor` style.
-
=== :strikethrough » a string ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
Is this text stricken through? Two options here:
* "none" - no strikethrough
* "single" - a single-line strikethrough.
-'''Note:''' Green Shoes doesn't support `:strikethrough` style.
-
=== :stroke » a hex code, a rgb array or a range of either ===
For: ''background, banner, border, caption, inscription, para, line, oval,
rect, shape, star, subtitle, tagline, title''.
@@ -1645,21 +1610,17 @@
`:top` style is given, the object is automatically placed in the natural flow
of the slot it contains.
=== :undercolor » a Shoes::Color ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
The color used to underline text.
-'''Note:''' Green Shoes doesn't support `:undercolor` style.
-
=== :underline » a string ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
Dictates the style of underline used in the text.
The choices for this setting are:
@@ -1667,12 +1628,10 @@
* "single" - a continuous underline.
* "double" - two continuous parallel underlines.
* "low" - a lower underline, beneath the font baseline. (This is generally recommended only for single characters, particularly when showing keyboard accelerators.)
* "error" - a wavy underline, usually found indicating a misspelling.
-'''Note:''' Green Shoes doesn't support `:underline` style.
-
=== :variant » a string ===
For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
strong, sub, sup, subtitle, tagline, title''.
@@ -1683,12 +1642,11 @@
'''Note:''' Green Shoes doesn't support `:variant` style.
=== :weight » a string ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''.
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
Set the boldness of the text. Commonly, this style is set to one of the
following strings:
* "ultralight" - the ultralight weight (= 200)
@@ -1699,33 +1657,28 @@
* "ultrabold" - the ultrabold weight (= 800)
* "heavy" - the heavy weight (= 900)
However, you may also pass in the numerical weight directly.
-'''Note:''' Green Shoes doesn't support `:weight` style.
-
=== :width » a number ===
For: ''all slots and elements''.
Sets the pixel width for the element. If the number is a decimal, the width is
converted to a percentage (with 0.0 being 0% and 1.0 being 100%.) A width of
100% means the object fills its parent slot.
=== :wrap » a string ===
-For: ''banner, caption, code, del, em, ins, inscription, link, para, span,
-strong, sub, sup, subtitle, tagline, title''
+For: ''banner, caption, inscription, para, span, subtitle, tagline, title''.
How should the text wrap when it fills its width? Possible options are:
* "word" - Break lines at word breaks.
* "char" - Break lines between characters, thus breaking some words.
* "trim" - Cut the line off with an ellipsis if it goes too long.
-'''Note:''' Green Shoes doesn't support `:wrap` style.
-
== Classes List ==
There is a complete list of all the classes introduced by Green Shoes.
Look at [[http://rdoc.info/github/ashbb/green_shoes/master/frames/file/README.md Green Shoes RDoc]].
@@ -2302,11 +2255,16 @@
=== span(text) » Shoes::Span ===
Creates a Span text fragment, unstyled by default.
-'''Note:''' Green Shoes doesn't support `span` method.
+{{{
+ Shoes.app do
+ tagline "\n", 'hello ' * 5,
+ span(em('Green Shoes'), size: 8, rise: 15)
+ end
+}}}
=== stack(styles) { ... } » Shoes::Stack ===
Creates a new stack. A stack is a type of slot. (See the main [[Slots]] page
for a full explanation of both stacks and flows.)
@@ -3194,12 +3152,10 @@
=== focus() » self ===
Moves focus to the button. The button will be highlighted and, if the user
hits Enter, the button will be clicked.
-'''Note:''' Green Shoes doesn't support `focus` method.
-
== Check ==
Check boxes are clickable square boxes than can be either checked or unchecked.
A single checkbox usually asks a "yes" or "no" question. Sets of checkboxes
are also seen in to-do lists. !{:margin_left => 100}man-ele-check.png!
@@ -3276,12 +3232,10 @@
=== focus() » self ===
Moves focus to the check. The check will be highlighted and, if the user hits
Enter, the check will be toggled between its checked and unchecked states.
-'''Note:''' Green Shoes doesn't support `focus` method.
-
== EditBox ==
Edit boxes are wide, rectangular boxes for entering text. On the web, they
call these textareas. These are multi-line edit boxes for entering longer
descriptions. Essays, even! !{:margin_left => 100}man-ele-editbox.png!
@@ -3327,12 +3281,10 @@
=== focus() » self ===
Moves focus to the edit box. The edit box will be highlighted and the user will
be able to type into the edit box.
-'''Note:''' Green Shoes doesn't support `focus` method.
-
=== text() » self ===
Return a string of characters which have been typed into the box.
=== text = a string ===
@@ -3377,12 +3329,10 @@
=== focus() » self ===
Moves focus to the edit line. The edit line will be highlighted and the user
will be able to type into the edit line.
-'''Note:''' Green Shoes doesn't support `focus` method.
-
=== text() » self ===
Return a string of characters which have been typed into the box.
=== text = a string ===
@@ -3515,12 +3465,10 @@
=== focus() » self ===
Moves focus to the list box. The list box will be highlighted and, if the user
hits the up and down arrow keys, other options in the list will be selected.
-'''Note:''' Green Shoes doesn't support `focus` method.
-
=== items() » an array of strings ===
Returns the complete list of strings that the list box presently shows as its options.
=== items = an array of strings ===
@@ -3672,13 +3620,10 @@
Clicks are sent for both marking and unmarking the radio.
=== focus() » self ===
-Moves focus to the radio. The radio will be highlighted and, if the user hits
-Enter, the radio will be toggled between its marked and unmarked states.
-
-'''Note:''' Green Shoes doesn't support `focus` method.
+Moves focus to the radio. The radio will be highlighted.
== Shape ==
A shape is a path outline usually created by drawing methods like `oval` and
`rect`. !{:margin_left => 100}man-ele-shape.png!