libs/gtkmm2/atk/atkmm/streamablecontent.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _ATKMM_STREAMABLECONTENT_H
   4 #define _ATKMM_STREAMABLECONTENT_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 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  30 extern "C"
  31 {
  32   typedef struct _AtkStreamableContentIface AtkStreamableContentIface;
  33   typedef struct _AtkStreamableContent      AtkStreamableContent;
  34 }
  35 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  36
  37
  38 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  39 typedef struct _AtkStreamableContent AtkStreamableContent;
  40 typedef struct _AtkStreamableContentClass AtkStreamableContentClass;
  41 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  42
  43
  44 namespace Atk
  45 { class StreamableContent_Class; } // namespace Atk
  46 namespace Atk
  47 {
  48
  49 class Object;
  50
  51 /** The ATK interface which provides access to streamable content.
  52  */
  53
  54 class StreamableContent : public Glib::Interface
  55 {
  56
  57 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  58
  59 public:
  60   typedef StreamableContent CppObjectType;
  61   typedef StreamableContent_Class CppClassType;
  62   typedef AtkStreamableContent BaseObjectType;
  63   typedef AtkStreamableContentIface BaseClassType;
  64
  65 private:
  66   friend class StreamableContent_Class;
  67   static CppClassType streamablecontent_class_;
  68
  69   // noncopyable
  70   StreamableContent(const StreamableContent&);
  71   StreamableContent& operator=(const StreamableContent&);
  72
  73 protected:
  74   StreamableContent(); // you must derive from this class
  75
  76 public:
  77   // This is public so that C++ wrapper instances can be
  78   // created for C instances of unwrapped types.
  79   // For instance, if an unexpected C type implements the C interface.
  80   explicit StreamableContent(AtkStreamableContent* castitem);
  81
  82 protected:
  83 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  84
  85 public:
  86   virtual ~StreamableContent();
  87
  88   static void add_interface(GType gtype_implementer);
  89
  90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  91   static GType get_type()      G_GNUC_CONST;
  92   static GType get_base_type() G_GNUC_CONST;
  93 #endif
  94
  95   ///Provides access to the underlying C GObject.
  96   AtkStreamableContent*       gobj()       { return reinterpret_cast<AtkStreamableContent*>(gobject_); }
  97
  98   ///Provides access to the underlying C GObject.
  99   const AtkStreamableContent* gobj() const { return reinterpret_cast<AtkStreamableContent*>(gobject_); }
 100
 101 private:
 102
 103 public:
 104
 105
 106   /** Gets the number of mime types supported by this object.
 107    * @return A <tt>int</tt> which is the number of mime types supported by the object.
 108    */
 109   int get_n_mime_types() const;
 110
 111   /** Gets the character string of the specified mime type. The first mime
 112    * type is at position 0, the second at position 1, and so on.
 113    * @param i A <tt>int</tt> representing the position of the mime type starting from 0.
 114    * @return : a gchar* representing the specified mime type; the caller
 115    * should not free the character string.
 116    */
 117   Glib::ustring get_mime_type(int i) const;
 118
 119   /** Gets the content in the specified mime type.
 120    * @param mime_type A gchar* representing the mime type.
 121    * @return A G::IOChannel which contains the content in the specified mime
 122    * type.
 123    */
 124   Glib::RefPtr<Glib::IOChannel> get_stream(const Glib::ustring& mime_type);
 125
 126 protected:
 127   #ifdef GLIBMM_VFUNCS_ENABLED
 128   virtual int get_n_mime_types_vfunc() const;
 129 #endif //GLIBMM_VFUNCS_ENABLED
 130
 131   #ifdef GLIBMM_VFUNCS_ENABLED
 132   virtual const gchar* get_mime_type_vfunc(int i) const;
 133 #endif //GLIBMM_VFUNCS_ENABLED
 134
 135   #ifdef GLIBMM_VFUNCS_ENABLED
 136   virtual GIOChannel* get_stream_vfunc(const Glib::ustring& mime_type);
 137 #endif //GLIBMM_VFUNCS_ENABLED
 138
 139
 140 public:
 141
 142 public:
 143   //C++ methods used to invoke GTK+ virtual functions:
 144 #ifdef GLIBMM_VFUNCS_ENABLED
 145 #endif //GLIBMM_VFUNCS_ENABLED
 146
 147 protected:
 148   //GTK+ Virtual Functions (override these to change behaviour):
 149 #ifdef GLIBMM_VFUNCS_ENABLED
 150 #endif //GLIBMM_VFUNCS_ENABLED
 151
 152   //Default Signal Handlers::
 153 #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 154 #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 155
 156
 157 };
 158
 159 } // namespace Atk
 160
 161
 162 namespace Glib
 163 {
 164   /** A Glib::wrap() method for this object.
 165    *
 166    * @param object The C instance.
 167    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 168    * @result A C++ instance that wraps this C instance.
 169    *
 170    * @relates Atk::StreamableContent
 171    */
 172   Glib::RefPtr<Atk::StreamableContent> wrap(AtkStreamableContent* object, bool take_copy = false);
 173
 174 } // namespace Glib
 175
 176
 177 #endif /* _ATKMM_STREAMABLECONTENT_H */
 178