QtViewer.qo.h

Go to the documentation of this file.

//# QtViewer.qo.h: Qt implementation of main viewer supervisory object
//#              -- Gui level.
//# Copyright (C) 2005
//# Associated Universities, Inc. Washington DC, USA.
//#
//# 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 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id$

#ifndef QTVIEWER_H
#define QTVIEWER_H
#include <list>
#include <string>
#if defined(WITHOUT_DBUS)
#include <queue>
#include <mutex>
#endif
#include <display/QtViewer/QtViewerBase.qo.h>

#include <graphics/X11/X_enter.h>
#  include <QObject>
#include <graphics/X11/X_exit.h>

namespace casa { //# NAMESPACE CASA - BEGIN

        class QtDBusViewerAdaptor;
        class QtDisplayPanelGui;
        class QtCleanPanelGui;
        class QtCleanPanelGui2;

#if defined(WITHOUT_DBUS)
        class grpcViewerState;
#endif

// <summary>
// Qt implementation of main viewer supervisory object -- Gui level.
// </summary>

// <synopsis>
// A QtViewer app should use just one QtViewer object, in all
// Probability; the rest of the objects will coordinate through it.
//
// The viewer is structured with a functional layer and a gui layer.
// In principle the former can operate without the latter.
// This class contains and manages various _gui_ objects associated with
// the viewer.  Its base manages the corresponding functional objects.
//
//   casacore::Functional objects     Related Gui objects
//   ------------------     -------------------
//      QtViewerBase        QtViewer, QtDataManager, print dialog
//      QtDisplayData       QtDataOptionsPanel
//      QtDisplayPanel      QtDisplayPanelGui, panel options dialog
//
//      QtDisplayPanel _is_ also a display widget, but minimal,
//      without surrounding graphical interface (animator, menus, etc.)
//      to operate it.
//
// </synopsis>

        class QtViewer : public QtViewerBase {

                Q_OBJECT        //# Allows slot/signal definition.  Must only occur in
                //# implement/.../*.h files; also, makefile must include
                //# name of this file in 'mocs' section.

        public:

                // When DBus is used "server_string" is the DBus name for the viewer on the message bus, but
                // when gRPC is used "server_string" is the gRPC URL which should be used to register the
                // viewer server.
                QtViewer( const std::list<std::string> &args, bool is_server=false, const char *server_string=0 );
                ~QtViewer();

                // Called from casaviewer.cc, true indicates that this application has been activated,
                // false indicates that it has been deactivated. The application (with OSX anyway)
                // becomes deactivated when it looses application focus, e.g. when the user moves
                // to "mission control" etc. This is useful for signaling that the mouse has left
                // the display window... (in these cases where it leaves without dragging out)
                void activate( bool );

                // name used to initialize connection to dbus
                static const QString &name( );

        public slots:

                // create a main display panel Gui
                virtual QtDisplayPanelGui *createDPG();
                virtual QtDisplayPanelGui *createDPG(const QtDisplayPanelGui *);
                virtual QtCleanPanelGui *createInteractiveCleanGui( );
                virtual QtCleanPanelGui2 *createInteractiveCleanGui2( );

                // Exits Qt loop.  (Note that the loop can be restarted (and is, in
                // interactive clean, e.g.), with existing widgets intact.  This
                // does not in itself delete objects or exit the process, although
                // the driver program might do that).  Also, some of the panels may
                // have WA_DeleteOnClose set, which would cause their deletion (see,
                // e.g., createDPG()).
                virtual void quit();

#if defined(WITHOUT_DBUS)

                void grpc_handle_op( );

        signals:
                void grpc_panel_result( QtDisplayPanelGui*, int );

        public:
                std::mutex grpc_queue_mutex;
                std::queue<std::function<void()>> grpc_queue;

#endif

        private:
                friend class QtDisplayPanelGui;
                void dpgDeleted(QtDisplayPanelGui*);

        protected:

#if ! defined(WITHOUT_DBUS)
                QtDBusViewerAdaptor* dbus_;
#else
                std::shared_ptr<grpcViewerState> grpc_;
#endif
                std::list<std::string> args_;

        private:
                static QString name_;
                QString server_string_;
                bool is_server_;
                typedef std::vector<QtDisplayPanelGui*> panel_list_t;
                panel_list_t panels;

        };



} //# NAMESPACE CASA - END

#endif