canvas.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the papyrus library.                             *
 *                                                                         *
 *   papyrus is free software; you can redistribute it and/or modify       *
 *   it under the terms of the GNU Lesser General Public License           *
 *   version 3.0 as published by the Free Software Foundation.             *
 *                                                                         *
 *   papyrus 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 Lesser General Public License version 3.0 for more details.       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with the papyrus library. If not, see                   *
 *   <http://www.gnu.org/licenses/>.                                       *
 ***************************************************************************/
#ifndef PAPYRUSCANVAS_H
#define PAPYRUSCANVAS_H

#include <papyrus/enums.h>
#include <papyrus/group.h>

#include <cairomm/cairomm.h>

namespace Papyrus
{

  class Canvas: public Group
  {

      // TODO change inheritance to eliminate the drawable matrix transformation functions

    protected:

      Canvas ( const Glib::ustring& id, double width, double height, double scale );

    public:
      PAPYRUS_DRAWABLE(Canvas);

      static pointer create ( double width=0.0, double height=0.0, double scale=1.0 );

      static pointer create ( const Glib::ustring& id, double width=0.0, double height=0.0, double scale=1.0 );

      virtual ~Canvas();

      virtual Matrix global_matrix() const;

      virtual Region global_extents() const;

      Region anchor_extents() const;

      double width() const;

      double height() const;

      void size ( double& width, double& height ) const;

      void set_width ( double width );

      void set_height ( double height );

      void set_size ( double width, double height );

      Units units() const;

      void set_units( Units u );

      void device_resolution( double& x, double& y ) const;

      bool set_device_resolution( double x, double y );

      Paint::pointer background() const;

      void set_background ( Paint::pointer background );

      void scroll_to ( double offset_x, double offset_y );

      void scroll_to_x( double offset_x );

      void scroll_to_y( double offset_y );

      void scroll_to_center();

      void scroll_position ( double& x, double& y ) const;

      double scroll_x() const;

      double scroll_y() const;

      void set_scroll_anchor ( ScrollAnchor scroll_achor = SCROLL_ANCHOR_CENTER );

      ScrollAnchor scroll_anchor() const;

      void scroll_anchor_offsets( double& x, double& y ) const;

      double scroll_anchor_x_offset() const;

      double scroll_anchor_y_offset() const;

      void window_to_canvas ( double& x, double& y ) const;

      void canvas_to_window ( double& x, double& y ) const;

      virtual Selection select ( double x, double y, unsigned depth = 1 );

      sigc::signal<void> signal_size_changed();

      sigc::signal<void,Units> signal_units();

      sigc::signal<void,double,double> signal_display_resolution();

      sigc::signal<void,double,double> signal_scrolled();

      sigc::signal<void,ScrollAnchor> signal_scroll_anchor_changed();
      
    protected:
      double m_width, m_height;
      double m_scale;

      ScrollAnchor m_scroll_anchor;

      double m_scroll_anchor_offset_x;
      
      double m_scroll_anchor_offset_y;

      double m_scroll_x;

      double m_scroll_y;
      
      Units m_units;
      double m_display_x_resolution, m_display_y_resolution;

      Paint::pointer m_background;

      sigc::signal<void> m_signal_size_changed;

      sigc::signal<void,Units> m_signal_units;

      sigc::signal<void,double,double> m_signal_display_resolution;

      sigc::signal<void,double,double> m_signal_scrolled;

      sigc::signal<void,ScrollAnchor> m_signal_scroll_anchor_changed;

      virtual void draw ( Context& cairo ) const;

      virtual Matrix calculate_composed_matrix() const;
  
      void update_scroll_anchor_offsets();

//       virtual void calculate_raw_extents();


  };

}

#endif