QtMouseToolState.qo.h

Go to the documentation of this file.

//# QtMouseToolState.qo.h: constants and [global] mouse-button state
//# for the qtviewer 'mouse-tools' used by its display panel[s].
//# 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 QTMOUSETOOLSTATE_QO_H_
#define QTMOUSETOOLSTATE_QO_H_

#include <casa/aips.h>
#include <casa/BasicSL/String.h>
#include <display/Display/MouseToolState.h>
#include <display/Utilities/Lowlevel.h>

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

namespace casa { //# NAMESPACE CASA - BEGIN


        class QtViewerBase;


// <synopsis>
// QtMouseToolState records the currently-active mouse button (if any)
// of each type of Qt mouse tool.  There may be a QtMouseToolBar for each
// QtDisplayPanel (and in principle each may display a different subset
// of all the possible tools, though this is not implemented yet (7/06)).
// However, each mouse button (Left, Middle, Right) may be assigned to
// at most one type of tool type, and that assignment should be the same
// on each QtMouseToolBar.
//
// To accomplish that, this class signals current button assignments
// whenever such assignments change.  All display panels and/or their mouse
// tool bars may connect to this signal to keep Toolbar button icons and the
// actual core library mouse tools (such as MWCZoomer) in sync.
//
// This button state is therefore also essentially global or static, but this
// class cannot be purely static because it must be a real QObject
// to send out such a signal.  Instead, there should be only one
// QtMouseToolState object (managed by the [one] QtViewer[Base] object),
// and all listeners should use that object for setting and responding to
// current mouse tool button state.
// </synopsis>

        class QtMouseToolState : public QObject {


                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:

                // Returns button currently assigned to a tool (0 = no button assigned).
                int buttonOf(casacore::String tool) {
                        return mousebtns_[QtMouseToolNames::toolIndex(tool)];
                }

                // Returns name of tool currently assigned to a mouse button (1, 2, or 3).
                // (Returns NONE if passed mousebtn is 0 or no tool is assigned to it).
                casacore::String toolOnButton(int mousebtn) {
                        return QtMouseToolNames::toolName(toolIndexOnButton_(mousebtn));
                }

                int getButtonState(const std::string &tool) const;


        public slots:

                // Request reassignment of a given mouse button to a tool.
                // NB: _This_ is where guis, etc. should request a button change, so that
                // all stay on the same page (not directly to tool or displaypanel, e.g.).
                void chgMouseBtn(casacore::String tool, int mousebtn);
                void mouseBtnStateChg(casacore::String tool, int state);

                // Request signalling of the current mouse button setting for every
                // type of tool.  Call this if you want to assure that everyone's
                // up-to-date on mouse button settings.
                void emitBtns();


        signals:

                // Notification of a tool's [new] mouse button.
                void mouseBtnChg(std::string tool, int mousebtn);


        protected:
                casacore::Casarc &rc;

                // Only QtviewerBase is intended to create/destroy
                // a [single] instance of this class.
                QtMouseToolState();
                ~QtMouseToolState() {  }
                friend class QtViewerBase;

                // Returns index of tool currently assigned to a mouse button (1, 2, or 3).
                // (Returns nTools if passed mousebtn is 0 or no tool is assigned to it).
                int toolIndexOnButton_(int mousebtn);


                // The button currently assigned to the various types of mouse tool.
                //
                // mousebtns_ value    Corresp. internal library value
                // ----------------     -------------------------------
                // 0:  <no button>     Display::K_None
                // 1:  LeftButton      Display::K_Pointer_Button1
                // 2:  MidButton       Display::K_Pointer_Button2
                // 3:  RightButton     Display::K_Pointer_Button3
                static int mousebtns_[QtMouseToolNames::nTools+1];
                //# Initial values; correspond to QtMouseToolNames::tools[], above.
                //# mousebtns_[nTools] is an entry for an invalid tool.
                //# At most one of the above will be 1,2,3; the rest will be 0.

        private:
                std::map<std::string,int> tool_state;
                void initButtonState( std::string, int );
                void initToolState( );

        };

} //# NAMESPACE CASA - END

#endif