gtksourceview3/gtksourceview/gtksourceregion.h

133 lines
4.1 KiB
C

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
* gtksourceregion.h - GtkTextMark-based region utility
* This file is part of GtkSourceView
*
* Copyright (C) 2002 Gustavo Giráldez <gustavo.giraldez@gmx.net>
* Copyright (C) 2016 Sébastien Wilmet <swilmet@gnome.org>
*
* This library 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.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef GTK_SOURCE_REGION_H
#define GTK_SOURCE_REGION_H
#if !defined (GTK_SOURCE_H_INSIDE) && !defined (GTK_SOURCE_COMPILATION)
# if defined (__GNUC__)
# warning "Only <gtksourceview/gtksource.h> can be included directly."
# elif defined (G_OS_WIN32)
# pragma message("Only <gtksourceview/gtksource.h> can be included directly.")
# endif
#endif
#include <gtk/gtk.h>
#include <gtksourceview/gtksourceversion.h>
G_BEGIN_DECLS
#define GTK_SOURCE_TYPE_REGION (gtk_source_region_get_type ())
GTK_SOURCE_AVAILABLE_IN_3_22
G_DECLARE_DERIVABLE_TYPE (GtkSourceRegion, gtk_source_region,
GTK_SOURCE, REGION,
GObject)
struct _GtkSourceRegionClass
{
GObjectClass parent_class;
/* Padding for future expansion */
gpointer padding[8];
};
/**
* GtkSourceRegionIter:
*
* #GtkSourceRegionIter is an opaque datatype; ignore all its fields.
* Initialize the iter with gtk_source_region_get_start_region_iter().
*
* Since: 3.22
*/
typedef struct _GtkSourceRegionIter GtkSourceRegionIter;
struct _GtkSourceRegionIter
{
/*< private >*/
gpointer dummy1;
guint32 dummy2;
gpointer dummy3;
};
GTK_SOURCE_AVAILABLE_IN_3_22
GtkSourceRegion * gtk_source_region_new (GtkTextBuffer *buffer);
GTK_SOURCE_AVAILABLE_IN_3_22
GtkTextBuffer * gtk_source_region_get_buffer (GtkSourceRegion *region);
GTK_SOURCE_AVAILABLE_IN_3_22
void gtk_source_region_add_subregion (GtkSourceRegion *region,
const GtkTextIter *_start,
const GtkTextIter *_end);
GTK_SOURCE_AVAILABLE_IN_3_22
void gtk_source_region_add_region (GtkSourceRegion *region,
GtkSourceRegion *region_to_add);
GTK_SOURCE_AVAILABLE_IN_3_22
void gtk_source_region_subtract_subregion (GtkSourceRegion *region,
const GtkTextIter *_start,
const GtkTextIter *_end);
GTK_SOURCE_AVAILABLE_IN_3_22
void gtk_source_region_subtract_region (GtkSourceRegion *region,
GtkSourceRegion *region_to_subtract);
GTK_SOURCE_AVAILABLE_IN_3_22
GtkSourceRegion * gtk_source_region_intersect_subregion (GtkSourceRegion *region,
const GtkTextIter *_start,
const GtkTextIter *_end);
GTK_SOURCE_AVAILABLE_IN_3_22
GtkSourceRegion * gtk_source_region_intersect_region (GtkSourceRegion *region1,
GtkSourceRegion *region2);
GTK_SOURCE_AVAILABLE_IN_3_22
gboolean gtk_source_region_is_empty (GtkSourceRegion *region);
GTK_SOURCE_AVAILABLE_IN_3_22
gboolean gtk_source_region_get_bounds (GtkSourceRegion *region,
GtkTextIter *start,
GtkTextIter *end);
GTK_SOURCE_AVAILABLE_IN_3_22
void gtk_source_region_get_start_region_iter (GtkSourceRegion *region,
GtkSourceRegionIter *iter);
GTK_SOURCE_AVAILABLE_IN_3_22
gboolean gtk_source_region_iter_is_end (GtkSourceRegionIter *iter);
GTK_SOURCE_AVAILABLE_IN_3_22
gboolean gtk_source_region_iter_next (GtkSourceRegionIter *iter);
GTK_SOURCE_AVAILABLE_IN_3_22
gboolean gtk_source_region_iter_get_subregion (GtkSourceRegionIter *iter,
GtkTextIter *start,
GtkTextIter *end);
GTK_SOURCE_AVAILABLE_IN_3_22
gchar * gtk_source_region_to_string (GtkSourceRegion *region);
G_END_DECLS
#endif /* GTK_SOURCE_REGION_H */