Import Upstream version 2.0.0+dfsgupstream/2.0.0+dfsg

1 files changed, 98 insertions, 0 deletions

diff --git a/src/lib/arch/IArchTaskBarReceiver.h b/src/lib/arch/IArchTaskBarReceiver.h
new file mode 100644
index 0000000..8a925b4
--- /dev/null
+++ b/src/lib/arch/IArchTaskBarReceiver.h
@@ -0,0 +1,98 @@
+/*
+ * barrier -- mouse and keyboard sharing utility
+ * Copyright (C) 2012-2016 Symless Ltd.
+ * Copyright (C) 2003 Chris Schoeneman
+ * 
+ * This package is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * found in the file LICENSE that should have accompanied this file.
+ * 
+ * This package 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/>.
+ */
+
+#pragma once
+
+#include "base/String.h"
+#include "common/IInterface.h"
+
+class IScreen;
+class INode;
+
+//! Interface for architecture dependent task bar event handling
+/*!
+This interface defines the task bar icon event handlers required
+by barrier.  Each architecture must implement this interface
+though each operation can be a no-op.
+*/
+class IArchTaskBarReceiver : public IInterface {
+public:
+    // Icon data is architecture dependent
+    typedef void* Icon;
+
+    //! @name manipulators
+    //@{
+
+    //! Show status window
+    /*!
+    Open a window displaying current status.  This should return
+    immediately without waiting for the window to be closed.
+    */
+    virtual void        showStatus() = 0;
+
+    //! Popup menu
+    /*!
+    Popup a menu of operations at or around \c x,y and perform the
+    chosen operation.
+    */
+    virtual void        runMenu(int x, int y) = 0;
+
+    //! Perform primary action
+    /*!
+    Perform the primary (default) action.
+    */
+    virtual void        primaryAction() = 0;
+
+    //@}
+    //! @name accessors
+    //@{
+
+    //! Lock receiver
+    /*!
+    Locks the receiver from changing state.  The receiver should be
+    locked when querying it's state to ensure consistent results.
+    Each call to \c lock() must have a matching \c unlock() and
+    locks cannot be nested.
+    */
+    virtual void        lock() const = 0;
+
+    //! Unlock receiver
+    virtual void        unlock() const = 0;
+
+    //! Get icon
+    /*!
+    Returns the icon to display in the task bar.  The interface
+    to set the icon is left to subclasses.  Getting and setting
+    the icon must be thread safe.
+    */
+    virtual const Icon    getIcon() const = 0;
+
+    //! Get tooltip
+    /*!
+    Returns the tool tip to display in the task bar.  The interface
+    to set the tooltip is left to sublclasses.  Getting and setting
+    the icon must be thread safe.
+    */
+    virtual std::string    getToolTip() const = 0;
+
+    virtual void updateStatus(INode*, const String& errorMsg) = 0;
+
+    virtual void cleanup() {}
+
+    //@}
+};