svn/view/view.rb


require "event_manager.rb"
require "window.rb"
require "modeline.rb"

module Edmaru

  #Abstract class to implement system specific view.
  module View

    #Construct the view instance.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Argument
    #_event_manager_ :: An instance of Edmaru::EventManager to handler
    #all events raised from this view.
    #
    #=== Return
    #An initialized instance of View.
    def initialize(event_manager)
      @event_manager = event_manager
      @mini_window = Edmaru::window_class.new
      @modeline_window = Edmaru::ModeLine.new
      @windows = Array.new
      @windows.push(Edmaru::window_class.new)
      init_ui
    end

    #The system specific initialization for this view.
    #
    #=== Warning
    #This method *MUST* be overrided in derived classes.
    def init_ui
    end

    #The mini window displayed in the bottom of the screen.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def mini_window
      @mini_window
    end

    #The modeline window displayed on the second line from the bottom.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def modeline_window
      @modeline_window
    end

    #The main window.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def main_window
      @windows[0]
    end

    #Main loop to catch all events.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def main_loop
    end

    #Exit the running main loop.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    #
    #=== Note
    #Some UI systems (such as Ncurses) don't exit the main loop as
    #soon as this method is called.
    def exit_main_loop
    end

    #Beep once.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def beep
      false
    end

    #Terminate this view instance.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def terminate
    end
  end
end