serverWidget.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_VIEW_KERNEL_SERVERWIDGET_H
#define BALL_VIEW_KERNEL_SERVERWIDGET_H

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_DATATYPE_HASHMAP_H
# include <BALL/DATATYPE/hashMap.h>
#endif

#ifndef BALL_VIEW_KERNEL_MODULARWIDGET_H
# include <BALL/VIEW/KERNEL/modularWidget.h>
#endif

#ifndef BALL_CONCEPT_OBJECTCREATOR_H
# include <BALL/CONCEPT/objectCreator.h>
#endif

#ifndef BALL_SYSTEM_NETWORKING_H
# include <BALL/SYSTEM/networking.h>
#endif

#ifndef BALL_VIEW_KERNEL_THREADS_H
# include <BALL/VIEW/KERNEL/threads.h>
#endif

#include <QtCore/QTimer>
#include <QtGui/QLabel>

class QLabel;

namespace BALL
{
  class Composite;

  namespace VIEW
  {
    class ServerPreferences;
    class Preferences;

    class BALL_VIEW_EXPORT ServerWidget
        : public QObject,
          public ModularWidget
    {
      Q_OBJECT

      public:

      BALL_EMBEDDABLE(ServerWidget,ModularWidget)

      
      
      
      class BALL_VIEW_EXPORT NotCompositeObject:  public Exception::GeneralException
      {
        public:

        NotCompositeObject(const char* file, int line);
      };


      class BALLViewServer
        : public virtual BALLThread,
          public virtual TCPServerThread
      {
        public:
          BALLViewServer(ServerWidget* parent, Size port, bool restart = true);

          void sendObject()
            throw(NotCompositeObject);

          virtual void run();

          virtual void handleConnection();

          void setLocked(bool is_locked);

        protected:
          ServerWidget* parent_widget_;
          Composite* received_composite_;

          typedef HashMap<unsigned long, Composite *> CompositeHashMap;
          CompositeHashMap composite_hashmap_;

          Size port_;
          bool is_locked_;
      };


      ServerWidget(QWidget* parent = 0, const char* name = 0);

      // only for Python interface
      ServerWidget(const ServerWidget& server);



      virtual ~ServerWidget();

      virtual void clear();


      virtual void activate() {};

      virtual void deactivate() {};

      void setPort(const int port);

      int getPort() const;

      void registerObjectCreator(const ObjectCreator& s);

      void unregisterObjectCreator();

      ObjectCreator& getObjectCreator();

      const ObjectCreator& getObjectCreator() const;

      virtual void initializeWidget(MainControl& main_control);
      
      virtual void finalizeWidget(MainControl& main_control);
      
      virtual void initializePreferencesTab(Preferences &preferences);
      
      virtual void finalizePreferencesTab(Preferences &preferences);
      
      virtual void applyPreferences();



      virtual bool isValid() const;

      virtual void dump(std::ostream& s = std::cout, Size depth = 0) const;

      virtual void changeLock(bool lock);


      public slots:
        void handleLocking(bool lock);

      signals:
        void lockRequested(bool lock);

      private:

      BALLViewServer server_;

      ObjectCreator *object_creator_;

      // the port to bind to
      int             port_; 

      ServerPreferences  *server_preferences_;
      QLabel             *server_icon_;
      static const char  *mini_ray_xpm_[];
    };


#   ifndef BALL_NO_INLINE_FUNCTIONS
#     include <BALL/VIEW/KERNEL/serverWidget.iC>
#   endif
  
  }// namespace VIEW
}// namespace BALL

#endif // BALL_VIEW_KERNEL_SERVER_H