Module: Vedeu::Toggleable::ClassMethods

Defined in:

lib/vedeu/models/toggleable.rb

Overview

Provide class methods to models to allow the visibility to be changed.

Instance Method Summary

• #hide(name = Vedeu.focus) ⇒ void (also: #hide_cursor, #hide_group, #hide_interface)

  Hides the model.

• #show(name = Vedeu.focus) ⇒ void (also: #show_cursor, #show_group, #show_interface)

  Shows the model.

• #toggle(name = Vedeu.focus) ⇒ void (also: #toggle_cursor, #toggle_group, #toggle_interface)

  Toggles the visibility of the model.

Instance Method Details

#hide(name = Vedeu.focus) ⇒ void Also known as: hide_cursor, hide_group, hide_interface

This method returns an undefined value.

Hides the model.

Examples:

Vedeu.hide_cursor(name)
Vedeu.hide_group(name)
Vedeu.hide_interface(name)

Parameters:

• name (String|Symbol) (defaults to: Vedeu.focus)

# File 'lib/vedeu/models/toggleable.rb', line 58

def hide(name = Vedeu.focus)
  repository.by_name(name).hide
end

#show(name = Vedeu.focus) ⇒ void Also known as: show_cursor, show_group, show_interface

This method returns an undefined value.

Shows the model.

Examples:

Vedeu.show_cursor(name)
Vedeu.show_group(name)
Vedeu.show_interface(name)

Parameters:

• name (String|Symbol) (defaults to: Vedeu.focus)

# File 'lib/vedeu/models/toggleable.rb', line 74

def show(name = Vedeu.focus)
  repository.by_name(name).show
end

#toggle(name = Vedeu.focus) ⇒ void Also known as: toggle_cursor, toggle_group, toggle_interface

This method returns an undefined value.

Toggles the visibility of the model.

Examples:

Vedeu.toggle_cursor(name)
Vedeu.toggle_group(name)
Vedeu.toggle_interface(name)

Parameters:

• name (String|Symbol) (defaults to: Vedeu.focus)

# File 'lib/vedeu/models/toggleable.rb', line 90

def toggle(name = Vedeu.focus)
  repository.by_name(name).toggle
end