libs/gtkmm2/atk/atkmm/hypertext.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _ATKMM_HYPERTEXT_H
   4 #define _ATKMM_HYPERTEXT_H
   5
   6
   7 #include <glibmm.h>
   8
   9 /* $Id$ */
  10
  11 /* Copyright (C) 2003 The gtkmm Development Team
  12  *
  13  * This library is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU Library General Public
  15  * License as published by the Free Software Foundation; either
  16  * version 2 of the License, or (at your option) any later version.
  17  *
  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  * Library General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Library 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.
  26  */
  27
  28
  29 #include <atkmm/hyperlink.h>
  30
  31 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  32 extern "C"
  33 {
  34   typedef struct _AtkHypertextIface AtkHypertextIface;
  35   typedef struct _AtkHypertext      AtkHypertext;
  36 }
  37 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  38
  39 /** The ATK interface which provides standard mechanism for manipulating hyperlinks.
  40  */
  41 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  42 typedef struct _AtkHypertext AtkHypertext;
  43 typedef struct _AtkHypertextClass AtkHypertextClass;
  44 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  45
  46
  47 namespace Atk
  48 { class Hypertext_Class; } // namespace Atk
  49 namespace Atk
  50 {
  51
  52 class Object;
  53
  54
  55 class Hypertext : public Glib::Interface
  56 {
  57
  58 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  59
  60 public:
  61   typedef Hypertext CppObjectType;
  62   typedef Hypertext_Class CppClassType;
  63   typedef AtkHypertext BaseObjectType;
  64   typedef AtkHypertextIface BaseClassType;
  65
  66 private:
  67   friend class Hypertext_Class;
  68   static CppClassType hypertext_class_;
  69
  70   // noncopyable
  71   Hypertext(const Hypertext&);
  72   Hypertext& operator=(const Hypertext&);
  73
  74 protected:
  75   Hypertext(); // you must derive from this class
  76
  77 public:
  78   // This is public so that C++ wrapper instances can be
  79   // created for C instances of unwrapped types.
  80   // For instance, if an unexpected C type implements the C interface.
  81   explicit Hypertext(AtkHypertext* castitem);
  82
  83 protected:
  84 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  85
  86 public:
  87   virtual ~Hypertext();
  88
  89   static void add_interface(GType gtype_implementer);
  90
  91 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  92   static GType get_type()      G_GNUC_CONST;
  93   static GType get_base_type() G_GNUC_CONST;
  94 #endif
  95
  96   ///Provides access to the underlying C GObject.
  97   AtkHypertext*       gobj()       { return reinterpret_cast<AtkHypertext*>(gobject_); }
  98
  99   ///Provides access to the underlying C GObject.
 100   const AtkHypertext* gobj() const { return reinterpret_cast<AtkHypertext*>(gobject_); }
 101
 102 private:
 103
 104 public:
 105
 106
 107   /** Gets the link in this hypertext document at index
 108    *  @a link_index
 109    * @param link_index An integer specifying the desired link.
 110    * @return The link in this hypertext document at
 111    * index @a link_index .
 112    */
 113   Glib::RefPtr<Hyperlink> get_link(int link_index);
 114
 115   /** Gets the link in this hypertext document at index
 116    *  @a link_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 .
 120    */
 121   Glib::RefPtr<const Hyperlink> get_link(int link_index) const;
 122
 123   /** Gets the number of links within this hypertext document.
 124    * @return The number of links within this hypertext document.
 125    */
 126   int get_n_links() const;
 127
 128   /** Gets the index into the array of hyperlinks that is associated with
 129    * the character specified by @a char_index , or -1 if there is no hyperlink
 130    * associated with this character.
 131    * @param char_index A character index.
 132    * @return An index into the array of hyperlinks in @a hypertext .
 133    */
 134   int get_link_index(int char_index) const;
 135
 136
 137   /**
 138    * @par Prototype:
 139    * <tt>void on_my_%link_selected(int link_index)</tt>
 140    */
 141
 142   Glib::SignalProxy1< void,int > signal_link_selected();
 143
 144
 145   #ifdef GLIBMM_VFUNCS_ENABLED
 146   virtual Glib::RefPtr<Hyperlink> get_link_vfunc(int link_index);
 147 #endif //GLIBMM_VFUNCS_ENABLED
 148
 149   #ifdef GLIBMM_VFUNCS_ENABLED
 150   virtual int get_n_links_vfunc() const;
 151 #endif //GLIBMM_VFUNCS_ENABLED
 152
 153   #ifdef GLIBMM_VFUNCS_ENABLED
 154   virtual int get_link_index_vfunc(int char_index) const;
 155 #endif //GLIBMM_VFUNCS_ENABLED
 156
 157
 158 public:
 159
 160 public:
 161   //C++ methods used to invoke GTK+ virtual functions:
 162 #ifdef GLIBMM_VFUNCS_ENABLED
 163 #endif //GLIBMM_VFUNCS_ENABLED
 164
 165 protected:
 166   //GTK+ Virtual Functions (override these to change behaviour):
 167 #ifdef GLIBMM_VFUNCS_ENABLED
 168 #endif //GLIBMM_VFUNCS_ENABLED
 169
 170   //Default Signal Handlers::
 171 #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 172   virtual void on_link_selected(int link_index);
 173 #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 174
 175
 176 };
 177
 178 } // namespace Atk
 179
 180
 181 namespace Glib
 182 {
 183   /** A Glib::wrap() method for this object.
 184    *
 185    * @param object The C instance.
 186    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 187    * @result A C++ instance that wraps this C instance.
 188    *
 189    * @relates Atk::Hypertext
 190    */
 191   Glib::RefPtr<Atk::Hypertext> wrap(AtkHypertext* object, bool take_copy = false);
 192
 193 } // namespace Glib
 194
 195
 196 #endif /* _ATKMM_HYPERTEXT_H */
 197