//  $Id: gui_component.hxx,v 1.14 2003/07/28 22:46:48 grumbel Exp $
// 
//  Construo - A wire-frame construction game
//  Copyright (C) 2002 Ingo Ruhnke <grumbel@gmx.de>
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 2
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
// 
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

#ifndef HEADER_CONSTRUO_GUI_COMPONENT_HXX
#define HEADER_CONSTRUO_GUI_COMPONENT_HXX

class GraphicContext;
class GUIManager;

/** A thing that is under the controll of the GUIManager */
class GUIComponent
{
protected:
  int x_pos;
  int y_pos;
  int width;
  int height;
  
public:
  GUIComponent (int x_, int y_, int width_, int height_)
    : x_pos (x_), y_pos (y_), width (width_), height (height_)
  {}

  virtual ~GUIComponent () {}

  virtual void draw (GraphicContext* gc) =0;

  /** @return true if the component is present at the given location */
  virtual bool is_at (int x, int y);

  void set_position (int x, int y) { x_pos = x, y_pos = y; }
  void set_width (int w) { width = w; }
  void set_height (int h) { height = h; }
  int  get_x_pos () { return x_pos; }
  int  get_y_pos () { return y_pos; }
  int  get_width () { return width; }
  int  get_height () { return height; }

  virtual void on_primary_button_press (int x, int y) {}
  virtual void on_primary_button_release (int x, int y) {}

  virtual void on_secondary_button_press (int x, int y) {}
  virtual void on_secondary_button_release (int x, int y) {}

  virtual void on_tertiary_button_press (int x, int y) {}
  virtual void on_tertiary_button_release (int x, int y) {}

  // FIXME: Join these under some generic event handling, like:
  // void on_button_press(int button_id, int x, int y);
  virtual void on_scale_press(int x, int y) {}
  virtual void on_grid_press(int x, int y) {}
  virtual void on_duplicate_press (int x, int y) {}
  virtual void on_delete_press (int x, int y) {}
  virtual void on_fix_press (int x, int y) {}
  virtual void on_join_press (int x, int y) {}

  virtual void on_mouse_enter () {}
  virtual void on_mouse_leave () {}

  virtual void wheel_up (int x, int y) {}
  virtual void wheel_down (int x, int y) {}

  virtual void on_button_press (int button_id, int x, int y) {}

  virtual void scroll_left () {}
  virtual void scroll_right () {}
  virtual void scroll_up () {}
  virtual void scroll_down () {}

  virtual void on_mouse_move (int x, int y, int of_x, int of_y) {}
};

#endif

/* EOF */