183 lines
6.4 KiB
C++
183 lines
6.4 KiB
C++
// -*- c++ -*-
|
|
// Generated by gtkmmproc -- DO NOT MODIFY!
|
|
#ifndef _PANGOMM_ATTRLIST_H
|
|
#define _PANGOMM_ATTRLIST_H
|
|
|
|
#include <glibmm.h>
|
|
|
|
/* $Id$ */
|
|
|
|
/* attrlist.h
|
|
*
|
|
* Copyright (C) 1998-1999 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 <pangomm/attributes.h>
|
|
#include <pangomm/attriter.h>
|
|
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
extern "C" { typedef struct _PangoAttrList PangoAttrList; }
|
|
#endif
|
|
|
|
namespace Pango
|
|
{
|
|
|
|
/** A Pango::AttrList represents a list of attributes that apply to a section of text.
|
|
* The attributes are, in general, allowed to overlap in an arbitrary fashion, however,
|
|
* if the attributes are manipulated only through Pango::AttrList::change(), the overlap between properties will meet stricter criteria.
|
|
*
|
|
* Since the Pango::AttrList structure is stored as a linear list, it is not suitable for storing attributes for large amounts of text.
|
|
* In general, you should not use a single Pango::AttrList for more than one paragraph of text.
|
|
*/
|
|
class AttrList
|
|
{
|
|
public:
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef AttrList CppObjectType;
|
|
typedef PangoAttrList BaseObjectType;
|
|
|
|
static GType get_type() G_GNUC_CONST;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
AttrList();
|
|
|
|
explicit AttrList(PangoAttrList* gobject, bool make_a_copy = true);
|
|
|
|
AttrList(const AttrList& other);
|
|
AttrList& operator=(const AttrList& other);
|
|
|
|
~AttrList();
|
|
|
|
void swap(AttrList& other);
|
|
|
|
///Provides access to the underlying C instance.
|
|
PangoAttrList* gobj() { return gobject_; }
|
|
|
|
///Provides access to the underlying C instance.
|
|
const PangoAttrList* gobj() const { return gobject_; }
|
|
|
|
///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
|
|
PangoAttrList* gobj_copy() const;
|
|
|
|
protected:
|
|
PangoAttrList* gobject_;
|
|
|
|
private:
|
|
|
|
|
|
public:
|
|
/** Constructs an attribute list by parsing a marked-up text (see markup format).
|
|
* If @a accel_marker is nonzero, the given character will mark the character
|
|
* following it as an accelerator. For example, the accel marker might be an
|
|
* ampersand or underscore. All characters marked as an accelerator will receive
|
|
* a Pango::UNDERLINE_LOW attribute.
|
|
* Two @a accel_marker characters following each other
|
|
* produce a single literal @a accel_marker character.
|
|
*
|
|
* @param markup_text Markup to parse (see markup format).
|
|
* @param accel_marker Character that precedes an accelerator, or <tt>0</tt> for none.
|
|
*/
|
|
explicit AttrList(const Glib::ustring& markup_text, gunichar accel_marker=0);
|
|
|
|
/** Constructs an attribute list by parsing a marked-up text (see markup format).
|
|
* @a text is set to the plaintext string.
|
|
* If @a accel_marker is nonzero, the given character will mark the character
|
|
* following it as an accelerator. For example, the accel marker might be an
|
|
* ampersand or underscore. All characters marked as an accelerator will receive
|
|
* a Pango::UNDERLINE_LOW attribute. The first character so marked will be
|
|
* returned in @a accel_char. Two @a accel_marker characters following each other
|
|
* produce a single literal @a accel_marker character.
|
|
*
|
|
* @param markup_text Markup to parse (see markup format).
|
|
* @param accel_marker Character that precedes an accelerator, or <tt>0</tt> for none.
|
|
* @param text Return location for text with tags stripped.
|
|
* @param accel_char Return location for accelerator char.
|
|
*/
|
|
AttrList(const Glib::ustring& markup_text, gunichar accel_marker, Glib::ustring& text, gunichar& accel_char);
|
|
|
|
void insert(Attribute& attr);
|
|
// hand code because we need to pass a copy of the attribute
|
|
void insert_before(Attribute& attr);
|
|
// hand code because we need to pass a copy of the attribute
|
|
void change(Attribute& attr);
|
|
// hand code because we need to pass a copy of the attribute
|
|
|
|
/** This function splices attribute list @a other into @a list .
|
|
* This operation is equivalent to stretching every attribute
|
|
* applies at position @a pos in @a list by an amount @a len ,
|
|
* and then calling pango_attr_list_change() with a copy
|
|
* of each attributes in @a other in sequence (offset in position by @a pos ).
|
|
*
|
|
* This operation proves useful for, for instance, inserting
|
|
* a preedit string in the middle of an edit buffer.
|
|
* @param other Another Pango::AttrList.
|
|
* @param pos The position in @a list at which to insert @a other .
|
|
* @param len The length of the spliced segment. (Note that this
|
|
* must be specified since the attributes in @a other
|
|
* may only be present at some subsection of this range).
|
|
*/
|
|
void splice(AttrList& other, int pos, int len);
|
|
|
|
/** Create a iterator initialized to the beginning of the list.
|
|
* @return A new Pango::Iterator. @a list must not be modified
|
|
* until this iterator is freed with pango_attr_iterator_destroy().
|
|
*/
|
|
AttrIter get_iter();
|
|
|
|
//TODO: Though it doesn't seem important:
|
|
//PangoAttrList* pango_attr_list_filter (PangoAttrList* list, PangoAttrFilterFunc func, gpointer data)
|
|
|
|
|
|
};
|
|
|
|
} //namespace Pango
|
|
|
|
|
|
namespace Pango
|
|
{
|
|
|
|
/** @relates Pango::AttrList
|
|
* @param lhs The left-hand side
|
|
* @param rhs The right-hand side
|
|
*/
|
|
inline void swap(AttrList& lhs, AttrList& rhs)
|
|
{ lhs.swap(rhs); }
|
|
|
|
} // namespace Pango
|
|
|
|
namespace Glib
|
|
{
|
|
|
|
/** @relates Pango::AttrList
|
|
* @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.
|
|
*/
|
|
Pango::AttrList wrap(PangoAttrList* object, bool take_copy = false);
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
template <>
|
|
class Value<Pango::AttrList> : public Glib::Value_Boxed<Pango::AttrList>
|
|
{};
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
} // namespace Glib
|
|
|
|
#endif /* _PANGOMM_ATTRLIST_H */
|
|
|