1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/stdapis/dbus-1.0/dbus/dbus.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,103 @@
     1.4 +/* -*- mode: C; c-file-style: "gnu" -*- */
     1.5 +/* dbus.h  Convenience header including all other headers
     1.6 + *
     1.7 + * Copyright (C) 2002, 2003  Red Hat Inc.
     1.8 + *
     1.9 + * Licensed under the Academic Free License version 2.1
    1.10 + * 
    1.11 + * This program is free software; you can redistribute it and/or modify
    1.12 + * it under the terms of the GNU General Public License as published by
    1.13 + * the Free Software Foundation; either version 2 of the License, or
    1.14 + * (at your option) any later version.
    1.15 + *
    1.16 + * This program is distributed in the hope that it will be useful,
    1.17 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.18 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.19 + * GNU General Public License for more details.
    1.20 + * 
    1.21 + * You should have received a copy of the GNU General Public License
    1.22 + * along with this program; if not, write to the Free Software
    1.23 + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    1.24 + *
    1.25 + */
    1.26 +
    1.27 +#ifndef DBUS_H
    1.28 +#define DBUS_H
    1.29 +
    1.30 +#define DBUS_INSIDE_DBUS_H 1
    1.31 +
    1.32 +#include <dbus/dbus-arch-deps.h>
    1.33 +#include <dbus/dbus-address.h>
    1.34 +#include <dbus/dbus-bus.h>
    1.35 +#include <dbus/dbus-connection.h>
    1.36 +#include <dbus/dbus-errors.h>
    1.37 +#include <dbus/dbus-macros.h>
    1.38 +#include <dbus/dbus-message.h>
    1.39 +#include <dbus/dbus-misc.h>
    1.40 +#include <dbus/dbus-pending-call.h>
    1.41 +#include <dbus/dbus-protocol.h>
    1.42 +#include <dbus/dbus-server.h>
    1.43 +#include <dbus/dbus-shared.h>
    1.44 +#include <dbus/dbus-signature.h>
    1.45 +#include <dbus/dbus-threads.h>
    1.46 +#include <dbus/dbus-types.h>
    1.47 +
    1.48 +#undef DBUS_INSIDE_DBUS_H
    1.49 +
    1.50 +/**
    1.51 + * @defgroup DBus D-Bus low-level public API
    1.52 + * @brief The low-level public API of the D-Bus library
    1.53 + *
    1.54 + * libdbus provides a low-level C API intended primarily for use by
    1.55 + * bindings to specific object systems and languages.  D-Bus is most
    1.56 + * convenient when used with the GLib bindings, Python bindings, Qt
    1.57 + * bindings, Mono bindings, and so forth.  This low-level API has a
    1.58 + * lot of complexity useful only for bindings.
    1.59 + * 
    1.60 + * @{
    1.61 + */
    1.62 +
    1.63 +/** @} */
    1.64 +
    1.65 +/**
    1.66 + * @mainpage
    1.67 + *
    1.68 + * This manual documents the <em>low-level</em> D-Bus C API. <b>If you use
    1.69 + * this low-level API directly, you're signing up for some pain.</b>
    1.70 + *
    1.71 + * Caveats aside, you might get started learning the low-level API by reading
    1.72 + * about @ref DBusConnection and @ref DBusMessage.
    1.73 + * 
    1.74 + * There are several other places to look for D-Bus information, such
    1.75 + * as the tutorial and the specification; those can be found at <a
    1.76 + * href="http://www.freedesktop.org/wiki/Software/dbus">the D-Bus
    1.77 + * website</a>. If you're interested in a sysadmin or package
    1.78 + * maintainer's perspective on the dbus-daemon itself and its
    1.79 + * configuration, be sure to check out the man pages as well.
    1.80 + *
    1.81 + * The low-level API documented in this manual deliberately lacks
    1.82 + * most convenience functions - those are left up to higher-level libraries
    1.83 + * based on frameworks such as GLib, Qt, Python, Mono, Java,
    1.84 + * etc. These higher-level libraries (often called "D-Bus bindings")
    1.85 + * have features such as object systems and main loops that allow a
    1.86 + * <em>much</em> more convenient API.
    1.87 + * 
    1.88 + * The low-level API also contains plenty of clutter to support
    1.89 + * integration with arbitrary object systems, languages, main loops,
    1.90 + * and so forth. These features add a lot of noise to the API that you
    1.91 + * probably don't care about unless you're coding a binding.
    1.92 + *
    1.93 + * This manual also contains docs for @ref DBusInternals "D-Bus internals",
    1.94 + * so you can use it to get oriented to the D-Bus source code if you're
    1.95 + * interested in patching the code. You should also read the
    1.96 + * file HACKING which comes with the source code if you plan to contribute to
    1.97 + * D-Bus.
    1.98 + *
    1.99 + * As you read the code, you can identify internal D-Bus functions
   1.100 + * because they start with an underscore ('_') character. Also, any
   1.101 + * identifier or macro that lacks a DBus, dbus_, or DBUS_ namepace
   1.102 + * prefix is internal, with a couple of exceptions such as #NULL,
   1.103 + * #TRUE, and #FALSE.
   1.104 + */
   1.105 +
   1.106 +#endif /* DBUS_H */