2
// Generated by gtkmmproc -- DO NOT MODIFY!
3
#ifndef _ATKMM_HYPERTEXT_H
4
#define _ATKMM_HYPERTEXT_H
9
/* $Id: hypertext.hg,v 1.3 2006/04/12 11:11:24 murrayc Exp $ */
11
/* Copyright (C) 2003 The gtkmm Development Team
13
* This library is free software; you can redistribute it and/or
14
* modify it under the terms of the GNU Lesser General Public
15
* License as published by the Free Software Foundation; either
16
* version 2.1 of the License, or (at your option) any later version.
18
* This library is distributed in the hope that it will be useful,
19
* but WITHOUT ANY WARRANTY; without even the implied warranty of
20
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21
* Lesser General Public License for more details.
23
* You should have received a copy of the GNU Lesser General Public
24
* License along with this library; if not, write to the Free
25
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29
#include <atkmm/hyperlink.h>
31
#ifndef DOXYGEN_SHOULD_SKIP_THIS
34
typedef struct _AtkHypertextIface AtkHypertextIface;
35
typedef struct _AtkHypertext AtkHypertext;
37
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
39
/** The ATK interface which provides standard mechanism for manipulating hyperlinks.
41
#ifndef DOXYGEN_SHOULD_SKIP_THIS
42
typedef struct _AtkHypertext AtkHypertext;
43
typedef struct _AtkHypertextClass AtkHypertextClass;
44
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
48
{ class Hypertext_Class; } // namespace Atk
55
class Hypertext : public Glib::Interface
58
#ifndef DOXYGEN_SHOULD_SKIP_THIS
61
typedef Hypertext CppObjectType;
62
typedef Hypertext_Class CppClassType;
63
typedef AtkHypertext BaseObjectType;
64
typedef AtkHypertextIface BaseClassType;
67
friend class Hypertext_Class;
68
static CppClassType hypertext_class_;
71
Hypertext(const Hypertext&);
72
Hypertext& operator=(const Hypertext&);
75
Hypertext(); // you must derive from this class
77
/** Called by constructors of derived classes. Provide the result of
78
* the Class init() function to ensure that it is properly
81
* @param interface_class The Class object for the derived type.
83
explicit Hypertext(const Glib::Interface_Class& interface_class);
86
// This is public so that C++ wrapper instances can be
87
// created for C instances of unwrapped types.
88
// For instance, if an unexpected C type implements the C interface.
89
explicit Hypertext(AtkHypertext* castitem);
92
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
97
static void add_interface(GType gtype_implementer);
99
#ifndef DOXYGEN_SHOULD_SKIP_THIS
100
static GType get_type() G_GNUC_CONST;
101
static GType get_base_type() G_GNUC_CONST;
104
///Provides access to the underlying C GObject.
105
AtkHypertext* gobj() { return reinterpret_cast<AtkHypertext*>(gobject_); }
107
///Provides access to the underlying C GObject.
108
const AtkHypertext* gobj() const { return reinterpret_cast<AtkHypertext*>(gobject_); }
115
/** Gets the link in this hypertext document at index
117
* @param link_index An integer specifying the desired link.
118
* @return The link in this hypertext document at
119
* index @a link_index.
121
Glib::RefPtr<Hyperlink> get_link(int link_index);
123
/** Gets the link in this hypertext document at index
125
* @param link_index An integer specifying the desired link.
126
* @return The link in this hypertext document at
127
* index @a link_index.
129
Glib::RefPtr<const Hyperlink> get_link(int link_index) const;
131
/** Gets the number of links within this hypertext document.
132
* @return The number of links within this hypertext document.
134
int get_n_links() const;
136
/** Gets the index into the array of hyperlinks that is associated with
137
* the character specified by @a char_index.
138
* @param char_index A character index.
139
* @return An index into the array of hyperlinks in @a hypertext,
140
* or -1 if there is no hyperlink associated with this character.
142
int get_link_index(int char_index) const;
147
* <tt>void on_my_%link_selected(int link_index)</tt>
150
Glib::SignalProxy1< void,int > signal_link_selected();
153
virtual Glib::RefPtr<Hyperlink> get_link_vfunc(int link_index);
155
virtual int get_n_links_vfunc() const;
157
virtual int get_link_index_vfunc(int char_index) const;
163
//C++ methods used to invoke GTK+ virtual functions:
166
//GTK+ Virtual Functions (override these to change behaviour):
168
//Default Signal Handlers::
169
virtual void on_link_selected(int link_index);
179
/** A Glib::wrap() method for this object.
181
* @param object The C instance.
182
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
183
* @result A C++ instance that wraps this C instance.
185
* @relates Atk::Hypertext
187
Glib::RefPtr<Atk::Hypertext> wrap(AtkHypertext* object, bool take_copy = false);
192
#endif /* _ATKMM_HYPERTEXT_H */
added
removed
atk/atkmm/hypertext.h
