lib/vedeu/cursors/dsl.rb in vedeu-0.6.68 vs lib/vedeu/cursors/dsl.rb in vedeu-0.6.69
- old
+ new
@@ -2,41 +2,17 @@
module Cursors
# Control the visibility of the cursor for each interface/view.
#
+ # See {file:docs/cursors.md#interface_cursors}
+ # See {file:docs/cursors.md#view_cursors}
module DSL
# Set the cursor visibility on an interface.
#
# @param value [Boolean] Any value other than nil or false will
- # evaluate
- # to true.
- #
- # @example
- # Vedeu.interface :my_interface do
- # cursor true # => show the cursor for this interface
- # # or...
- # cursor :show # => both of these are equivalent to line
- # # above
- # # or...
- # cursor! #
- # # ...
- # end
- #
- # Vedeu.interface :my_interface do
- # cursor false # => hide the cursor for this interface
- # # or...
- # cursor nil # => as above
- # # ...
- # end
- #
- # Vedeu.view :my_interface do
- # cursor true # => Specify the visibility of the cursor when
- # # the view is rendered.
- # # ...
- # end
- #
+ # evaluate to true.
# @return [Vedeu::Cursors::Cursor]
def cursor(value = true)
boolean = value ? true : false
model.cursor_visible = boolean