gimp/app/widgets/gimpview.h

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimppreview.h
 * Copyright (C) 2001 Michael Natterer <mitch@gimp.org>
 *
 * 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 __GIMP_PREVIEW_H__
#define __GIMP_PREVIEW_H__


#include <gtk/gtkdrawingarea.h>


#define GIMP_PREVIEW_MAX_SIZE         1024
#define GIMP_PREVIEW_MAX_POPUP_SIZE    256
#define GIMP_PREVIEW_MAX_BORDER_WIDTH   16


#define GIMP_TYPE_PREVIEW            (gimp_preview_get_type ())
#define GIMP_PREVIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_PREVIEW, GimpPreview))
#define GIMP_PREVIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_PREVIEW, GimpPreviewClass))
#define GIMP_IS_PREVIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE (obj, GIMP_TYPE_PREVIEW))
#define GIMP_IS_PREVIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_PREVIEW))
#define GIMP_PREVIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_PREVIEW, GimpPreviewClass))


typedef struct _GimpPreviewClass  GimpPreviewClass;

struct _GimpPreview
{
  GtkDrawingArea  parent_instance;

  GimpViewable   *viewable;

  gint            width;
  gint            height;
  gint            border_width;
  gboolean        dot_for_dot;

  GimpRGB         border_color;
  GdkGC          *border_gc;

  gboolean        is_popup;
  gboolean        clickable;
  gboolean        eat_button_events;
  gboolean        show_popup;

  /*< private >*/
  guchar         *buffer;
  gint            rowstride;

  GdkPixbuf      *no_preview_pixbuf;

  gint            size;
  gboolean        in_button;
  guint           press_state;
  guint           idle_id;
  gboolean        needs_render;
  guint           popup_id;
  gint            popup_x;
  gint            popup_y;
};

struct _GimpPreviewClass
{
  GtkDrawingAreaClass  parent_class;

  /*  signals  */
  void        (* clicked)          (GimpPreview *preview);
  void        (* double_clicked)   (GimpPreview *preview);
  void        (* extended_clicked) (GimpPreview *preview,
				    guint        modifier_state);
  void        (* context)          (GimpPreview *preview);

  /*  virtual functions  */
  void        (* render)           (GimpPreview *preview);
  gboolean    (* needs_popup)      (GimpPreview *preview);
  GtkWidget * (* create_popup)     (GimpPreview *preview);
};


GType        gimp_preview_get_type         (void) G_GNUC_CONST;

GtkWidget *  gimp_preview_new              (GimpViewable  *viewable,
					    gint           size,
					    gint           border_width,
					    gboolean       is_popup);
GtkWidget *  gimp_preview_new_full         (GimpViewable  *viewable,
					    gint           width,
					    gint           height,
					    gint           border_width,
					    gboolean       is_popup,
					    gboolean       clickable,
					    gboolean       show_popup);

GtkWidget *  gimp_preview_new_by_type      (GType          viewable_type,
					    gint           size,
					    gint           border_width,
					    gboolean       is_popup);

void         gimp_preview_set_viewable     (GimpPreview   *preview,
					    GimpViewable  *viewable);

void         gimp_preview_set_size         (GimpPreview   *preview,
					    gint           size,
					    gint           border_width);
void         gimp_preview_set_size_full    (GimpPreview   *preview,
					    gint           width,
					    gint           height,
					    gint           border_width);

void         gimp_preview_set_dot_for_dot  (GimpPreview   *preview,
					    gboolean       dot_for_dot);

void         gimp_preview_set_border_color (GimpPreview   *preview,
					    const GimpRGB *border_color);

void         gimp_preview_update           (GimpPreview   *preview);


/*  protected  */

typedef enum
{
  GIMP_PREVIEW_BG_CHECKS,
  GIMP_PREVIEW_BG_WHITE
} GimpPreviewBG;

void         gimp_preview_render_to_buffer (TempBuf       *temp_buf,
                                            gint           channel,
                                            GimpPreviewBG  inside_bg,
                                            GimpPreviewBG  outside_bg,
                                            guchar        *dest_buffer,
                                            gint           dest_width,
                                            gint           dest_height,
                                            gint           dest_rowstride);
void         gimp_preview_render_preview   (GimpPreview   *preview,
					    TempBuf       *temp_buf,
					    gint           channel,
                                            GimpPreviewBG  inside_bg,
                                            GimpPreviewBG  outside_bg);


#endif /* __GIMP_PREVIEW_H__ */