svn/view/view.rb


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

module Edmaru

  #Abstract class to implement system specific view.
  module View

    #Construct a 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

      init_ui

      #Show default windows.
      @windows = Array.new
      @windows.push
        Edmaru::window_class.new(self, 0, 0,
                                 allocated_column, allocated_line - 1)
      @mini_window =
        Edmaru::mini_window_class.new(self, 0,
                                      allocated_line - 1,
                                      allocated_column)
    end

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

    #The event manager linked to this view.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def event_manager
      @event_manager
    end

    #Total column size allocated for this view.
    #
    #=== Warning
    #This method *SHOULD* be overrided in drived classes.
    def allocated_column
      0
    end

    #Total numbe of lines allocated for this view.
    #
    #=== Warning
    #This method *SHOULD* be overrided in drived classes.
    def allocated_line
      0
    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 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 *MUST* *NOT* be overrided in derived classes.
    def terminate
      @windows.each{ |window|
        window.terminate
      }
      @mini_window.terminate

      terminate_ui
    end

    #Free system specifiec resources.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def terminate_ui
    end
  end
end