path: root/widgets/misc/e-printable.h

/*
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef _E_PRINTABLE_H_
#define _E_PRINTABLE_H_

#include <gtk/gtk.h>

G_BEGIN_DECLS

#define E_PRINTABLE_TYPE        (e_printable_get_type ())
#define E_PRINTABLE(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), E_PRINTABLE_TYPE, EPrintable))
#define E_PRINTABLE_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), E_PRINTABLE_TYPE, EPrintableClass))
#define E_IS_PRINTABLE(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), E_PRINTABLE_TYPE))
#define E_IS_PRINTABLE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_PRINTABLE_TYPE))

typedef struct {
    GObject   base;
} EPrintable;

typedef struct {
    GObjectClass parent_class;

    /*
     * Signals
     */

    void        (*print_page)  (EPrintable *etm, GtkPrintContext *context, gdouble width, gdouble height, gboolean quantized);
    gboolean    (*data_left)   (EPrintable *etm);
    void        (*reset)       (EPrintable *etm);
    gdouble     (*height)      (EPrintable *etm, GtkPrintContext *context, gdouble width, gdouble max_height, gboolean quantized);

    /* e_printable_will_fit (ep, ...) should be equal in value to
     * (e_printable_print_page (ep, ...),
     * !e_printable_data_left(ep)) except that the latter has the
     * side effect of doing the printing and advancing the
     * position of the printable.
     */

    gboolean    (*will_fit)    (EPrintable *etm, GtkPrintContext *context, gdouble width, gdouble max_height, gboolean quantized);
} EPrintableClass;

GType       e_printable_get_type (void);

EPrintable *e_printable_new                 (void);

/*
 * Routines for emitting signals on the e_table */
void        e_printable_print_page          (EPrintable        *e_printable,
                         GtkPrintContext *context,
                         gdouble            width,
                         gdouble            height,
                         gboolean           quantized);
gboolean    e_printable_data_left           (EPrintable        *e_printable);
void        e_printable_reset               (EPrintable        *e_printable);
gdouble     e_printable_height              (EPrintable        *e_printable,
                         GtkPrintContext *context,
                         gdouble            width,
                         gdouble            max_height,
                         gboolean           quantized);
gboolean    e_printable_will_fit            (EPrintable        *e_printable,
                         GtkPrintContext *context,
                         gdouble            width,
                         gdouble            max_height,
                         gboolean           quantized);

G_END_DECLS

#endif /* _E_PRINTABLE_H_ */