Reference Manual

sourceprintjob.h

Go to the documentation of this file.

/*  Inti-SourceView: Integrated Foundation Classes
 *  Copyright (C) 2003 The Inti Development Team.
 *
 *  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 Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library 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 INTI_GTK_SOURCE_PRINT_JOB_H
#define INTI_GTK_SOURCE_PRINT_JOB_H

#ifndef INTI_G_OBJECT_H
#include <inti/glib/object.h>
#endif

#ifndef INTI_GTK_ENUMS_H
#include <inti/gtk/enums.h>
#endif

#ifndef __GTK_SOURCE_PRINT_JOB_H__
#include <gtksourceview/gtksourceprintjob.h>
#endif

namespace Inti {

namespace Gtk {

class SourceBuffer;
class SourceView;
class TextIter;


class SourcePrintJob : public G::Object
{
        friend class G::Object;
        friend class SourcePrintJobClass;

        SourcePrintJob(const SourcePrintJob&);
        SourcePrintJob& operator=(const SourcePrintJob&);

protected:

        explicit SourcePrintJob(GtkSourcePrintJob *job, bool reference = false);


        virtual void on_begin_page();

        virtual void on_finished();
//  Properties

        typedef G::Property<GnomePrintConfig*, void*> ConfigPropertyType;
        typedef G::PropertyProxy<G::Object, ConfigPropertyType> ConfigPropertyProxy;
        static const ConfigPropertyType config_property;

        typedef G::Property<SourceBuffer*, G::Object*> BufferPropertyType;
        typedef G::PropertyProxy<G::Object, BufferPropertyType> BufferPropertyProxy;
        static const BufferPropertyType buffer_property;

        typedef G::Property<unsigned int> TabsWidthPropertyType;
        typedef G::PropertyProxy<G::Object, TabsWidthPropertyType> TabsWidthPropertyProxy;
        static const TabsWidthPropertyType tabs_width_property;

        typedef G::Property<WrapMode, int> WrapModePropertyType;
        typedef G::PropertyProxy<G::Object, WrapModePropertyType> WrapModePropertyProxy;
        static const WrapModePropertyType wrap_mode_property;

        typedef G::Property<bool> HighlightPropertyType;
        typedef G::PropertyProxy<G::Object, HighlightPropertyType> HighlightPropertyProxy;
        static const HighlightPropertyType highlight_property;

        typedef G::Property<String> FontPropertyType;
        typedef G::PropertyProxy<G::Object, FontPropertyType> FontPropertyProxy;
        static const FontPropertyType font_property;

        typedef G::Property<String> NumbersFontPropertyType;
        typedef G::PropertyProxy<G::Object, NumbersFontPropertyType> NumbersFontPropertyProxy;
        static const NumbersFontPropertyType numbers_font_property;

        typedef G::Property<unsigned int> PrintNumbersPropertyType;
        typedef G::PropertyProxy<G::Object, PrintNumbersPropertyType> PrintNumbersPropertyProxy;
        static const PrintNumbersPropertyType print_numbers_property;

        typedef G::Property<bool> PrintHeaderPropertyType;
        typedef G::PropertyProxy<G::Object, PrintHeaderPropertyType> PrintHeaderPropertyProxy;
        static const PrintHeaderPropertyType print_header_property;

        typedef G::Property<bool> PrintFooterPropertyType;
        typedef G::PropertyProxy<G::Object, PrintFooterPropertyType> PrintFooterPropertyProxy;
        static const PrintFooterPropertyType print_footer_property;

        typedef G::Property<String> HeaderFooterFontPropertyType;
        typedef G::PropertyProxy<G::Object, HeaderFooterFontPropertyType> HeaderFooterFontPropertyProxy;
        static const HeaderFooterFontPropertyType header_footer_font_property;

//  Signals

        typedef G::Signal0<void> BeginPageSignalType;
        typedef G::SignalProxy<TypeInstance, BeginPageSignalType> BeginPageSignalProxy;
        static const BeginPageSignalType begin_page_signal;

        typedef G::Signal0<void> FinishedSignalType;
        typedef G::SignalProxy<TypeInstance, FinishedSignalType> FinishedSignalProxy;
        static const FinishedSignalType finished_signal;

public:

        explicit SourcePrintJob(SourceBuffer *buffer = 0);

        explicit SourcePrintJob(GnomePrintConfig& config, SourceBuffer *buffer = 0);

        explicit SourcePrintJob(SourceView& view);

        virtual ~SourcePrintJob();


        GtkSourcePrintJob* gtk_source_print_job() const { return (GtkSourcePrintJob*)instance; }

        GtkSourcePrintJobClass* gtk_source_print_job_class() const;

        operator GtkSourcePrintJob* () const;

        bool is_gtk_source_print_job() const;

        GnomePrintConfig* get_config() const;

        SourceBuffer* get_buffer() const;

        unsigned int get_tabs_width() const;

        WrapMode get_wrap_mode() const;

        bool get_highlight() const;

        String get_font() const;

        String get_numbers_font() const;

        unsigned int get_print_numbers() const;

        void get_text_margins(double *top, double *bottom, double *left, double *right) const;

        GnomePrintJob* get_print_job() const;

        unsigned int get_page() const;

        unsigned int get_page_count() const;

        GnomePrintContext* get_print_context() const;

        bool get_print_header() const;

        bool get_print_footer() const;

        String get_header_footer_font() const;


        void set_config(GnomePrintConfig& config);

        void set_buffer(SourceBuffer& buffer);

        void set_tabs_width(unsigned int tabs_width);

        void set_wrap_mode(WrapMode wrap);

        void set_highlight(bool highlight);

        void set_font(const String& font_name);

        void set_numbers_font(const String& font_name);

        void set_print_numbers(unsigned int interval);

        void set_text_margins(double top, double bottom, double left, double right);

        GnomePrintJob* print();

        GnomePrintJob* print(const TextIter& start, const TextIter& end);

        bool print_async(const TextIter& start, const TextIter& end);

        void cancel();

        void set_print_header(bool setting);

        void set_print_footer(bool setting);

        void set_header_footer_font(const String& font_name);

        void set_header_format(const char *left, const char *center, const char *right, bool separator);
        void set_header_format(const String& left, const String& center, const String& right, bool separator);

        void set_footer_format(const char *left, const char *center, const char *right, bool separator);
        void set_footer_format(const String& left, const String& center, const String& right, bool separator);


        const ConfigPropertyProxy prop_config()
        {
                return ConfigPropertyProxy(this, &config_property);
        }

        const BufferPropertyProxy prop_buffer()
        {
                return BufferPropertyProxy(this, &buffer_property);
        }

        const TabsWidthPropertyProxy prop_tabs_width()
        {
                return TabsWidthPropertyProxy(this, &tabs_width_property);
        }

        const WrapModePropertyProxy prop_wrap_mode()
        {
                return WrapModePropertyProxy(this, &wrap_mode_property);
        }

        const HighlightPropertyProxy prop_highlight()
        {
                return HighlightPropertyProxy(this, &highlight_property);
        }

        const FontPropertyProxy prop_font()
        {
                return FontPropertyProxy(this, &font_property);
        }

        const NumbersFontPropertyProxy prop_numbers_font()
        {
                return NumbersFontPropertyProxy(this, &numbers_font_property);
        }

        const PrintNumbersPropertyProxy prop_print_numbers()
        {
                return PrintNumbersPropertyProxy(this, &print_numbers_property);
        }

        const PrintHeaderPropertyProxy prop_print_header()
        {
                return PrintHeaderPropertyProxy(this, &print_header_property);
        }

        const PrintFooterPropertyProxy prop_print_footer()
        {
                return PrintFooterPropertyProxy(this, &print_footer_property);
        }

        const HeaderFooterFontPropertyProxy prop_header_footer_font()
        {
                return HeaderFooterFontPropertyProxy(this, &header_footer_font_property);
        }


        const BeginPageSignalProxy sig_begin_page()
        {
                return BeginPageSignalProxy(this, &begin_page_signal);
        }

        const FinishedSignalProxy sig_finished()
        {
                return FinishedSignalProxy(this, &finished_signal);
        }

};

} // namespace Gtk

} // namespace Inti

#endif // INTI_GTK_SOURCE_PRINT_JOB_H