Reference Manual

sourcebuffer.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_BUFFER_H
#define INTI_GTK_SOURCE_BUFFER_H

#ifndef INTI_GTK_TEXT_BUFFER_H
#include <inti/gtk/textbuffer.h>
#endif

#ifndef INTI_GTK_SOURCE_LANGUAGE_H
#include <inti/gtk-sourceview/sourcelanguage.h>
#endif

#ifndef INTI_GTK_SOURCE_TAG_H
#include <inti/gtk-sourceview/sourcetag.h>
#endif

#ifndef __GTK_SOURCE_BUFFER_H__
#include <gtksourceview/gtksourcebuffer.h>
#endif

namespace Inti {

namespace Gtk {

class SourceBuffer;
class SourceBufferClass;
class SourceLanguage;
class SourceMarker;


class SourceMarker : public TextMark
{
        friend class G::Object;

        SourceMarker(const SourceMarker&);
        SourceMarker& operator=(const SourceMarker&);

protected:

        explicit SourceMarker(GtkSourceMarker *marker, bool reference = false);


public:

        virtual ~SourceMarker();


        GtkSourceMarker* gtk_source_marker() const { return (GtkSourceMarker*)instance; }

        GtkSourceMarkerClass* gtk_source_marker_class() const;

        operator GtkSourceMarker* () const;

        bool is_gtk_source_marker() const;

        String get_marker_type() const;

        int get_line() const;

        String get_name() const;

        SourceBuffer* get_buffer() const;

        SourceMarker* next() const;

        SourceMarker* prev() const;


        void set_marker_type(const String& type);

};


class SourceBuffer : public TextBuffer
{
        friend class G::Object;
        friend class SourceBufferClass;

        SourceBuffer(const SourceBuffer&);
        SourceBuffer& operator=(const SourceBuffer&);

protected:

        explicit SourceBuffer(GtkSourceBuffer *buffer, bool reference = false);


        virtual void on_can_undo(bool can_undo);

        virtual void on_can_redo(bool can_redo);

        virtual void on_highlight_updated(TextIter& start, TextIter& end);

        virtual void on_marker_updated(TextIter& where);

//  Properties

        typedef G::Property<G::Unichar> EscapeCharPropertyType;
        typedef G::PropertyProxy<G::Object, EscapeCharPropertyType> EscapeCharPropertyProxy;
        static const EscapeCharPropertyType escape_char_property;

        typedef G::Property<bool> CheckBracketsPropertyType;
        typedef G::PropertyProxy<G::Object, CheckBracketsPropertyType> CheckBracketsPropertyProxy;
        static const CheckBracketsPropertyType check_brackets_property;

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

        typedef G::Property<int> MaxUndoLevelsPropertyType;
        typedef G::PropertyProxy<G::Object, MaxUndoLevelsPropertyType> MaxUndoLevelsPropertyProxy;
        static const MaxUndoLevelsPropertyType max_undo_levels_property;

        typedef G::Property<SourceLanguage*, G::Object*> LanguagePropertyType;
        typedef G::PropertyProxy<G::Object, LanguagePropertyType> LanguagePropertyProxy;
        static const LanguagePropertyType language_property;

//  Signals

        typedef G::Signal1<void, bool> CanUndoSignalType;
        typedef G::SignalProxy<TypeInstance, CanUndoSignalType> CanUndoSignalProxy;
        static const CanUndoSignalType can_undo_signal;

        typedef G::Signal1<void, bool> CanRedoSignalType;
        typedef G::SignalProxy<TypeInstance, CanRedoSignalType> CanRedoSignalProxy;
        static const CanRedoSignalType can_redo_signal;

        typedef G::Signal2<void, GtkTextIter*, GtkTextIter*> HighlightUpdatedSignalType;
        typedef G::SignalProxy<TypeInstance, HighlightUpdatedSignalType> HighlightUpdatedSignalProxy;
        static const HighlightUpdatedSignalType highlight_updated_signal;

        typedef G::Signal1<void, GtkTextIter*> MarkerUpdatedSignalType;
        typedef G::SignalProxy<TypeInstance, MarkerUpdatedSignalType> MarkerUpdatedSignalProxy;
        static const MarkerUpdatedSignalType marker_updated_signal;

public:

        SourceBuffer(SourceTagTable *table = 0);

        SourceBuffer(const SourceLanguage& language);

        virtual ~SourceBuffer();


        GtkSourceBuffer* gtk_source_buffer() const { return (GtkSourceBuffer*)instance; }

        GtkSourceBufferClass* gtk_source_buffer_class() const;

        operator GtkSourceBuffer* () const;

        bool is_gtk_source_buffer() const;

        SourceTagTable* get_source_tag_table() const;

        bool get_check_brackets() const;

        bool get_highlight() const;

        int get_max_undo_levels() const;

        SourceLanguage* get_language() const;

        G::Unichar get_escape_char() const;

        bool can_undo() const;

        bool can_redo() const;

        SourceMarker* get_marker(const String& name) const;

        std::vector<SourceMarker*> get_markers(const TextIter& start, const TextIter& end) const;

        SourceMarker* get_first_marker() const;

        SourceMarker* get_last_marker() const;

        TextIter get_iter_at_marker(const SourceMarker& marker) const;

        SourceMarker* get_next_marker(TextIter& iter) const;

        SourceMarker* get_prev_marker(TextIter& iter) const;


        void set_check_brackets(bool check_brackets);

        void set_bracket_match_style(const SourceTagStyle& style);

        void set_highlight(bool highlight);

        void set_max_undo_levels(int max_undo_levels);

        void set_language(const SourceLanguage *language);

        void set_escape_char(G::Unichar escape_char);

        void undo();

        void redo();

        void begin_not_undoable_action();

        void end_not_undoable_action();

        SourceMarker* create_marker(const String& name, const String& type, const TextIter& where);

        void move_marker(SourceMarker& marker, const TextIter& where);

        void delete_marker(SourceMarker& marker);


        const EscapeCharPropertyProxy prop_escape_char()
        {
                return EscapeCharPropertyProxy(this, &escape_char_property);
        }

        const CheckBracketsPropertyProxy prop_check_brackets()
        {
                return CheckBracketsPropertyProxy(this, &check_brackets_property);
        }

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

        const MaxUndoLevelsPropertyProxy prop_max_undo_levels()
        {
                return MaxUndoLevelsPropertyProxy(this, &max_undo_levels_property);
        }

        const LanguagePropertyProxy prop_language()
        {
                return LanguagePropertyProxy(this, &language_property);
        }


        const CanUndoSignalProxy sig_can_undo()
        {
                return CanUndoSignalProxy(this, &can_undo_signal);
        }

        const CanRedoSignalProxy sig_can_redo()
        {
                return CanRedoSignalProxy(this, &can_redo_signal);
        }

        const HighlightUpdatedSignalProxy sig_highlight_updated()
        {
                return HighlightUpdatedSignalProxy(this, &highlight_updated_signal);
        }

        const MarkerUpdatedSignalProxy sig_marker_updated()
        {
                return MarkerUpdatedSignalProxy(this, &marker_updated_signal);
        }

};

} // namespace Gtk

} // namespace Inti

#endif // INTI_GTK_SOURCE_BUFFER_H