13
0
livetrax/libs/gtkmm2/atk/atkmm/document.h

168 lines
4.4 KiB
C
Raw Normal View History

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _ATKMM_DOCUMENT_H
#define _ATKMM_DOCUMENT_H
#include <glibmm.h>
/* $Id$ */
/* Copyright (C) 2003 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.
*/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C"
{
typedef struct _AtkDocumentIface AtkDocumentIface;
typedef struct _AtkDocument AtkDocument;
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _AtkDocument AtkDocument;
typedef struct _AtkDocumentClass AtkDocumentClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Atk
{ class Document_Class; } // namespace Atk
namespace Atk
{
class Object;
/** The ATK interface which allows access to a DOM associated with on object.
* This interface should be supported by any object that has an associated document object model (DOM). This interface
* provides the standard mechanism allowing an assistive technology access to the DOM.
*/
class Document : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Document CppObjectType;
typedef Document_Class CppClassType;
typedef AtkDocument BaseObjectType;
typedef AtkDocumentIface BaseClassType;
private:
friend class Document_Class;
static CppClassType document_class_;
// noncopyable
Document(const Document&);
Document& operator=(const Document&);
protected:
Document(); // you must derive from this class
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit Document(AtkDocument* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Document();
static void add_interface(GType gtype_implementer);
#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.
AtkDocument* gobj() { return reinterpret_cast<AtkDocument*>(gobject_); }
///Provides access to the underlying C GObject.
const AtkDocument* gobj() const { return reinterpret_cast<AtkDocument*>(gobject_); }
private:
public:
/** Gets a string indicating the document type.
* @return A string indicating the document type.
*/
Glib::ustring get_document_type() const;
/** Gets a %gpointer that points to an instance of the DOM. It is
* up to the caller to check atk_document_get_type to determine
* how to cast this pointer.
* @return A %gpointer that points to an instance of the DOM.
*/
gpointer get_document();
protected:
#ifdef GLIBMM_VFUNCS_ENABLED
virtual const gchar* get_document_type_vfunc();
#endif //GLIBMM_VFUNCS_ENABLED
#ifdef GLIBMM_VFUNCS_ENABLED
virtual gpointer get_document_vfunc() const;
#endif //GLIBMM_VFUNCS_ENABLED
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 Atk
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 Atk::Document
*/
Glib::RefPtr<Atk::Document> wrap(AtkDocument* object, bool take_copy = false);
} // namespace Glib
#endif /* _ATKMM_DOCUMENT_H */