Scrollable.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef SCROLLABLE_H
#define SCROLLABLE_H
 
#include "pedigree/kernel/debugger/DebuggerIO.h"
#include "pedigree/kernel/processor/types.h"
 
class Scrollable {
 public:
  Scrollable();
 
  void move(size_t x, size_t y);
  void resize(size_t width, size_t height);
  void scroll(ssize_t lines);
  void scrollTo(size_t absolute);
  void scrollHorizontal(ssize_t columns);
  void horizontalScrollTo(size_t absolute);
  void refresh(DebuggerIO* pScreen);
  void setScrollKeys(char up, char down);
  ssize_t getLine();
 
  void centreOn(size_t line);
 
  size_t height() const;
  size_t width() const;
 
  virtual const char* getLine1(size_t index, DebuggerIO::Colour& colour,
                               DebuggerIO::Colour& bgColour) = 0;
  virtual const char* getLine2(size_t index, size_t& colOffset, DebuggerIO::Colour& colour,
                               DebuggerIO::Colour& bgColour) = 0;
  virtual size_t getLineCount() = 0;
  virtual size_t getContentWidth();
  virtual ~Scrollable();
 
 protected:
  size_t m_x;
  size_t m_y;
  size_t m_width;
  size_t m_height;
  ssize_t m_line;
  size_t m_column;
  char m_ScrollUp;
  char m_ScrollDown;
};
 
#endif