Paul Davis
449aab3c46
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
273 lines
9.5 KiB
C++
273 lines
9.5 KiB
C++
// -*- c++ -*-
|
|
// Generated by gtkmmproc -- DO NOT MODIFY!
|
|
#ifndef _GTKMM_TEXTMARK_H
|
|
#define _GTKMM_TEXTMARK_H
|
|
|
|
|
|
#include <glibmm.h>
|
|
|
|
/* $Id$ */
|
|
|
|
/* textmark.h
|
|
*
|
|
* Copyright (C) 1998-2002 The gtkmm Development Team
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 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
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the Free
|
|
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
|
|
#include <gtkmm/object.h>
|
|
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef struct _GtkTextMark GtkTextMark;
|
|
typedef struct _GtkTextMarkClass GtkTextMarkClass;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
|
|
namespace Gtk
|
|
{ class TextMark_Class; } // namespace Gtk
|
|
namespace Gtk
|
|
{
|
|
|
|
class TextBuffer;
|
|
class TextIter;
|
|
|
|
/** Typedefed as Gtk::TextBuffer::Mark. A position in the buffer, preserved across buffer modifications.
|
|
*
|
|
* A Mark is like a bookmark in a text buffer; it preserves a position in the text. Unlike iterators, marks remain valid across buffer mutations, because
|
|
* their behavior is defined when text is inserted or deleted. When text containing a mark is deleted, the mark remains in
|
|
* the position originally occupied by the deleted text. When text is inserted at a mark, a mark with left gravity will be
|
|
* moved to the beginning of the newly-inserted text, and a mark with right gravity will be moved to the end.
|
|
* The standard text cursor in left-to-right languages is a mark with right gravity, because it stays to the right of inserted
|
|
* text.
|
|
*
|
|
* Like tags, marks can be either named or anonymous. There are two marks built-in to Gtk::TextBuffer; these are named "insert" and
|
|
* "selection_bound" and refer to the insertion point and the boundary of the selection which is not the insertion point,
|
|
* respectively. If no text is selected, these two marks will be in the same position. You can manipulate what is selected and
|
|
* where the cursor appears by moving these marks around.
|
|
*
|
|
* "left" and "right" here refer to logical direction (left is the toward the start of the buffer); in some languages such as
|
|
* Hebrew the logically-leftmost text is not actually on the left when displayed.
|
|
*
|
|
* You can convert the mark to an @link Gtk::TextIter iterator@endlink using Gtk::TextBuffer::get_iter_at_mark().
|
|
*
|
|
* Marks can be deleted from the buffer at any time with Gtk::TextBuffer::delete_mark(). Once deleted from the buffer, a mark is essentially useless.
|
|
*
|
|
* Marks optionally have names; these can be convenient to avoid passing the Gtk::TextBuffer::Mark object around.
|
|
*
|
|
* Marks are typically created using the Gtk::TextBuffer::create_mark() function.
|
|
*
|
|
* @ingroup TextView
|
|
*/
|
|
|
|
class TextMark : public Glib::Object
|
|
{
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
public:
|
|
typedef TextMark CppObjectType;
|
|
typedef TextMark_Class CppClassType;
|
|
typedef GtkTextMark BaseObjectType;
|
|
typedef GtkTextMarkClass BaseClassType;
|
|
|
|
private: friend class TextMark_Class;
|
|
static CppClassType textmark_class_;
|
|
|
|
private:
|
|
// noncopyable
|
|
TextMark(const TextMark&);
|
|
TextMark& operator=(const TextMark&);
|
|
|
|
protected:
|
|
explicit TextMark(const Glib::ConstructParams& construct_params);
|
|
explicit TextMark(GtkTextMark* castitem);
|
|
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
public:
|
|
virtual ~TextMark();
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
static GType get_type() G_GNUC_CONST;
|
|
static GType get_base_type() G_GNUC_CONST;
|
|
#endif
|
|
|
|
///Provides access to the underlying C GObject.
|
|
GtkTextMark* gobj() { return reinterpret_cast<GtkTextMark*>(gobject_); }
|
|
|
|
///Provides access to the underlying C GObject.
|
|
const GtkTextMark* gobj() const { return reinterpret_cast<GtkTextMark*>(gobject_); }
|
|
|
|
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
|
GtkTextMark* gobj_copy();
|
|
|
|
private:
|
|
|
|
protected:
|
|
|
|
/** Creates an anoymous text mark. Add it to a buffer using Gtk::TextBuffer::add_mark().
|
|
* If a mark has left
|
|
* gravity, and text is inserted at the mark's current location, the mark
|
|
* will be moved to the left of the newly-inserted text. If the mark has
|
|
* right gravity (@a left_gravity = false), the mark will end up on the
|
|
* right of newly-inserted text. The standard left-to-right cursor is a
|
|
* mark with right gravity (when you type, the cursor stays on the right
|
|
* side of the text you're typing).
|
|
|
|
* @param name mark name.
|
|
* @param left_gravity Whether the mark should have left gravity.
|
|
* @newin2p12
|
|
*/
|
|
explicit TextMark(bool left_gravity = true);
|
|
|
|
/** Creates a text mark. Add it to a buffer using Gtk::TextBuffer::add_mark().
|
|
* The mark can be retrieved by name using Gtk::TextBuffer::get_mark(). If a mark has left
|
|
* gravity, and text is inserted at the mark's current location, the mark
|
|
* will be moved to the left of the newly-inserted text. If the mark has
|
|
* right gravity (@a left_gravity = false), the mark will end up on the
|
|
* right of newly-inserted text. The standard left-to-right cursor is a
|
|
* mark with right gravity (when you type, the cursor stays on the right
|
|
* side of the text you're typing).
|
|
|
|
* @param name mark name.
|
|
* @param left_gravity Whether the mark should have left gravity.
|
|
* @newin2p12
|
|
*/
|
|
explicit TextMark(const Glib::ustring& name, bool left_gravity = true);
|
|
|
|
public:
|
|
|
|
/** Creates an anoymous text mark. Add it to a buffer using Gtk::TextBuffer::add_mark().
|
|
* If a mark has left
|
|
* gravity, and text is inserted at the mark's current location, the mark
|
|
* will be moved to the left of the newly-inserted text. If the mark has
|
|
* right gravity (@a left_gravity = false), the mark will end up on the
|
|
* right of newly-inserted text. The standard left-to-right cursor is a
|
|
* mark with right gravity (when you type, the cursor stays on the right
|
|
* side of the text you're typing).
|
|
|
|
* @param name mark name.
|
|
* @param left_gravity Whether the mark should have left gravity.
|
|
* @result A RefPtr to a new text mark.
|
|
* @newin2p12
|
|
*/
|
|
|
|
static Glib::RefPtr<TextMark> create(bool left_gravity = true);
|
|
|
|
|
|
/** Creates a text mark. Add it to a buffer using Gtk::TextBuffer::add_mark().
|
|
* The mark can be retrieved by name using Gtk::TextBuffer::get_mark(). If a mark has left
|
|
* gravity, and text is inserted at the mark's current location, the mark
|
|
* will be moved to the left of the newly-inserted text. If the mark has
|
|
* right gravity (@a left_gravity = false), the mark will end up on the
|
|
* right of newly-inserted text. The standard left-to-right cursor is a
|
|
* mark with right gravity (when you type, the cursor stays on the right
|
|
* side of the text you're typing).
|
|
|
|
* @param name mark name.
|
|
* @param left_gravity Whether the mark should have left gravity.
|
|
* @result A RefPtr to a new text mark.
|
|
* @newin2p12
|
|
*/
|
|
|
|
static Glib::RefPtr<TextMark> create(const Glib::ustring& name, bool left_gravity = true);
|
|
|
|
|
|
/** Sets the visibility of @a mark ; the insertion point is normally
|
|
* visible, i.e.\ you can see it as a vertical bar. Also, the text
|
|
* widget uses a visible mark to indicate where a drop will occur when
|
|
* dragging-and-dropping text. Most other marks are not visible.
|
|
* Marks are not visible by default.
|
|
* @param setting Visibility of mark.
|
|
*/
|
|
void set_visible(bool setting = true);
|
|
|
|
/** Return value: <tt>true</tt> if visible
|
|
* @return <tt>true</tt> if visible.
|
|
*/
|
|
bool get_visible() const;
|
|
|
|
/** Return value: mark name
|
|
* @return Mark name.
|
|
*/
|
|
Glib::ustring get_name() const;
|
|
|
|
/** Return value: whether the mark is deleted
|
|
* @return Whether the mark is deleted.
|
|
*/
|
|
bool get_deleted() const;
|
|
|
|
/** Gets the buffer this mark is located inside,
|
|
* or <tt>0</tt> if the mark is deleted.
|
|
* @return The mark's Gtk::TextBuffer.
|
|
*/
|
|
Glib::RefPtr<TextBuffer> get_buffer();
|
|
|
|
/** Gets the buffer this mark is located inside,
|
|
* or <tt>0</tt> if the mark is deleted.
|
|
* @return The mark's Gtk::TextBuffer.
|
|
*/
|
|
Glib::RefPtr<const TextBuffer> get_buffer() const;
|
|
|
|
/** Determines whether the mark has left gravity.
|
|
* @return <tt>true</tt> if the mark has left gravity, <tt>false</tt> otherwise.
|
|
*/
|
|
bool get_left_gravity() const;
|
|
|
|
//TODO: Add a const overload, if we have a ConstTextIter.
|
|
TextIter get_iter();
|
|
|
|
|
|
public:
|
|
|
|
public:
|
|
//C++ methods used to invoke GTK+ virtual functions:
|
|
#ifdef GLIBMM_VFUNCS_ENABLED
|
|
#endif //GLIBMM_VFUNCS_ENABLED
|
|
|
|
protected:
|
|
//GTK+ Virtual Functions (override these to change behaviour):
|
|
#ifdef GLIBMM_VFUNCS_ENABLED
|
|
#endif //GLIBMM_VFUNCS_ENABLED
|
|
|
|
//Default Signal Handlers::
|
|
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
|
|
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
|
|
|
|
|
|
};
|
|
|
|
} /* namespace Gtk */
|
|
|
|
|
|
namespace Glib
|
|
{
|
|
/** A Glib::wrap() method for this object.
|
|
*
|
|
* @param object The C instance.
|
|
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
|
|
* @result A C++ instance that wraps this C instance.
|
|
*
|
|
* @relates Gtk::TextMark
|
|
*/
|
|
Glib::RefPtr<Gtk::TextMark> wrap(GtkTextMark* object, bool take_copy = false);
|
|
}
|
|
|
|
|
|
#endif /* _GTKMM_TEXTMARK_H */
|
|
|