/usr/include/libqinfinity/browser.h is in libqinfinity-dev 1:0.5.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | /*
* Copyright 2009 Gregory Haynes <greg@greghaynes.net>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef QINFINITY_BROWSER_H
#define QINFINITY_BROWSER_H
#include "qgobject.h"
#include "browseriter.h"
#include <QPointer>
typedef struct _InfcBrowser InfcBrowser;
typedef struct _InfcBrowserIter InfcBrowserIter;
typedef struct _InfcExploreRequest InfcExploreRequest;
typedef struct _InfcNodeRequest InfcNodeRequest;
typedef struct _InfcSessionProxy InfcSessionProxy;
class QObject;
namespace QInfinity
{
class QtIo;
class CommunicationManager;
class XmlConnection;
class NotePlugin;
class SessionProxy;
class Session;
class AbstractTextBuffer;
class NodeRequest;
/**
* @brief Browse an infinote server.
*
* The Browser contains functionality related to navigating
* and monitoring nodes on an infinote server. To navigate
* the nodes on a server, use a BrowserIter.
*
* The BrowserModel is also useful for remote server browsing.
*/
class Browser
: public QGObject
{
Q_OBJECT;
public:
static QPointer<Browser> wrap( InfcBrowser *infBrowser,
QObject *parent = 0,
bool own_gobject = true );
/**
* @brief Create Browser for connection.
*/
Browser( CommunicationManager& comm_manager,
XmlConnection* connection,
QObject *parent = 0 );
/**
* @brief Get the connection status of the underlying infinity browser object.
*/
InfcBrowserStatus connectionStatus();
/**
* @brief Add plugin to browser session.
*/
bool addPlugin( NotePlugin &plugin );
/**
* @brief Create a new subdirectiory.
* @param parent Parent of new directory.
* @param name Name of new directory.
* @return Request for monitoring node creation.
*/
NodeRequest* addSubdirectory( BrowserIter parent,
const char *name );
/**
* @brief Create a new note.
* @param parent Parent node of new note.
* @param name Name of new note.
* @param plugin Plugin used for note.
* @param initial_subscribe Subscribe to note on creation.
*/
NodeRequest* addNote( BrowserIter parent,
const char *name,
NotePlugin &plugin,
bool initial_subscribe );
/**
* @brief Create a new note with specified content.
* @param parent Parent node of new note.
* @param name Name of new note.
* @param plugin Plugin used for note.
* @param initial_subscribe Subscribe to note on creation.
*/
NodeRequest* addNoteWithContent( BrowserIter parent,
const char *name,
NotePlugin &plugin,
Session &session,
bool initial_subscribe );
/**
* @brief Delete node.
* @param node Node to be deleted.
*/
NodeRequest* removeNode( BrowserIter node );
/**
* @brief Subscribe to editing session.
* @param node Note to subscribe to.
* @param plugin The plugin used for subscription
* @param textBuffer The text buffer which will be given to your createSession method as user data
*/
NodeRequest* subscribeSession( BrowserIter node, NotePlugin* plugin = 0,
QInfinity::AbstractTextBuffer* textBuffer = 0 );
/**
* @brief Gets the connection for this browser.
*
* @return QInfinity::XmlConnection* the connection associated with the browser
*/
XmlConnection* connection() const;
protected:
Browser( InfcBrowser *infBrowser,
QObject *parent = 0,
bool own_gobject = true );
Q_SIGNALS:
/**
* @brief A subdirectory has begun to be explored.
*
* The iter is only valid for the life of the signal
* handler.
*/
void beginExplore( const BrowserIter &iter,
InfcExploreRequest *request );
/**
* @brief A subscription request has been made.
* @param iter Iter pointing to nobe subscribed to.
* @param request Request for the operation.
*
* The iter is only valid for the life of the signal
* handler
*/
void beginSubscribe( const BrowserIter &iter,
InfcNodeRequest *request );
/**
* @brief A subscription to a note has been made.
*
* This does not mean the session is running. The
* session is likely still synchronizing.
*/
void subscribeSession( const QInfinity::BrowserIter &iter,
QPointer<QInfinity::SessionProxy> proxy );
/**
* @brief An error has occured.
*/
void error( const QInfinity::Browser* self, const QString error );
/**
* @brief A node has been created.
*/
void nodeAdded( const BrowserIter &iter );
/**
* @brief A node has been removed.
*/
void nodeRemoved( const BrowserIter &iter );
/**
* @brief The connection status of the browser has changed.
*/
void statusChanged( InfcBrowserStatus status );
/**
* @brief The browser is now fully connected.
*/
void connectionEstablished( const QInfinity::Browser* self );
private:
void setupSignals();
void signalBeginExplore( InfcBrowserIter *infIter,
InfcExploreRequest *request );
void signalBeginSubscribe( InfcBrowserIter *iter,
InfcNodeRequest *request );
void signalSubscribeSession( InfcBrowserIter *infIter,
InfcSessionProxy *proxy );
void signalNodeAdded( InfcBrowserIter *infIter );
void signalNodeRemoved( InfcBrowserIter *infIter );
void signalStatusChanged( InfcBrowserStatus status );
void signalError( const QString message );
static void begin_explore_cb( InfcBrowser *browser,
InfcBrowserIter *iter,
InfcExploreRequest *request,
void *user_data );
static void begin_subscribe_cb( InfcBrowser *browser,
InfcBrowserIter *iter,
InfcNodeRequest *request,
void *user_data );
static void subscribe_session_cb( InfcBrowser *browser,
InfcBrowserIter *iter,
InfcSessionProxy *proxy,
void *user_data );
static void node_added_cb( InfcBrowser *browser,
InfcBrowserIter *iter,
void *user_data );
static void node_removed_cb( InfcBrowser *browser,
InfcBrowserIter *iter,
void *user_data );
static void status_changed_cb( InfcBrowser *browser,
void *user_data );
static void error_cb( InfcBrowser *browser, const GError *error);
};
}
#endif
|