mirrors/JKQtPlotter
1
0
Fork 0
mirror of https://github.com/jkriege2/JKQtPlotter.git synced 2024-12-24 17:41:39 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

clean-up of special context menu code + added documentation

Browse Source
This commit is contained in:
jkriege2 2019-05-01 12:46:17 +02:00
parent fcc8122d75
commit f710048f49
5 changed files with 225 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
examples/test_user_interaction/README.md
View File

@ -115,4 +115,38 @@ You can also use the mouse to draw various geometricals forms. When you finish d
#### Ellipses
![](https://raw.githubusercontent.com/jkriege2/JKQtPlotter/master/doc/images/draw_ellipse.gif)
### Context Menus
#### Standard Context Menu
JKQTPlotter contains a standard context menu, which is shown if `plot->setContextMenuMode(jkqtpcmmStandardContextMenu);` was set.
It contains several standard ways of interacting with the plot, e.g. save to file, copy to clipboard, print, switch graph visibilities, ...
![](https://raw.githubusercontent.com/jkriege2/JKQtPlotter/master/screenshots/contextmenu_graph_visibility.png)
In addition JKQTPlotter provides several ways to customize this menu:
* You can add additional actions to the JKQTPlotter, by calling `JKQTPlotter::addAction()` (i.e. using the default Qt mechanism)
and/or by adding actions to the internal JKQTBasePlotter, using `JKQTBasePlotter::registerAdditionalAction()`
* You can modify the menu, when it is displayed, by connecting a slot to the signal `JKQTPlotter::contextMenuOPened(x,y,menu)`:
```.cpp
connect(plot, SIGNAL(contextMenuOpened(double, double, QMenu*)), this, SLOT(contextMenuOpened(double, double, QMenu*)));
// ...
void TestUserInteraction::contextMenuOpened(double x, double y, QMenu *contextMenu)
{
contextMenu->addSeparator();
QAction* act=contextMenu->addMenu(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y))->addAction("user-added action");
connect(act, &QAction::triggered, [x,y]() { QMessageBox::warning(nullptr, tr("Plot Context Menu"),
tr("Context Menu was opened at x/y=%1/%2!").arg(x).arg(y),
QMessageBox::Ok,
QMessageBox::Ok); });
labMouseAction->setText(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y));
}
```
#### Special Context Menu
In addition to the standard context menu, JKQTPlotter can also be configures to display a special, user-defined context menu.
To do so, call `plot->setContextMenuMode(jkqtpcmmSpecialContextMenu);` and set your menu, by calling `plot->setSpecialContextMenu(menu)`.
You can also combine the special menu and the standard menu, by calling `plot->setContextMenuMode(jkqtpcmmStandardAndSpecialContextMenu);`.

26
examples/test_user_interaction/test_user_interaction.cpp
View File

@ -8,6 +8,7 @@
#include "test_user_interaction.h"
#include <QMenuBar>
#include <QMessageBox>
#include <functional>
TestUserInteraction::TestUserInteraction(QWidget *parent) :
QMainWindow(parent)
@ -145,8 +146,8 @@ TestUserInteraction::TestUserInteraction(QWidget *parent) :
cmbRightClickContextMenu->addItem("jkqtpcmmStandardAndSpecialContextMenu");
cmbRightClickContextMenu->addItem("jkqtpcmmNoContextMenu");
cmbRightClickContextMenu->setCurrentIndex(0);
layForm->addRow("mouse action: right-click context menu:", cmbRightClickContextMenu);
connect(cmbRightClickContextMenu, SIGNAL(currentIndexChanged(int)), this, SLOT(setRightClickContextMenu(int)));
layForm->addRow("context menu mode:", cmbRightClickContextMenu);
connect(cmbRightClickContextMenu, SIGNAL(currentIndexChanged(int)), this, SLOT(setContextMenuMode(int)));
// ... and add a special context menu
QMenu* special=new QMenu(plot);
special->addAction("Special entry 1 (no action!)");
@ -243,7 +244,7 @@ void TestUserInteraction::setPlotMagnification(int index)
plot->setMagnification(cmbMagnification->itemData(index).toDouble());
}
void TestUserInteraction::setRightClickContextMenu(int index)
void TestUserInteraction::setContextMenuMode(int index)
{
plot->setContextMenuMode(static_cast<JKQTPContextMenuModes>(index));
}
@ -293,12 +294,19 @@ void TestUserInteraction::plotMouseWheelOperated(double x, double y, Qt::Keyboar
void TestUserInteraction::contextMenuOpened(double x, double y, QMenu *contextMenu)
{
contextMenu->addSeparator();
QAction* act=contextMenu->addMenu(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y))->addAction("user-added action");
connect(act, &QAction::triggered, [x,y]() { QMessageBox::warning(nullptr, tr("Plot Context Menu"),
tr("Context Menu was opened at x/y=%1/%2!").arg(x).arg(y),
QMessageBox::Ok,
QMessageBox::Ok); });
if (contextMenu!=plot->getSpecialContextMenu()) {
// We only want to alter the standard context menu, not the special one, as modifications there
// would be permanent! I.e. if this is called repeatedly, entries will accumulate!
//
// If you want to modify the special menu, do not add actions, but use pre-added actions, or reuse
// actions, once they have been added once!
contextMenu->addSeparator();
QAction* act=contextMenu->addMenu(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y))->addAction("user-added action");
connect(act, &QAction::triggered, [x,y]() { QMessageBox::warning(nullptr, tr("Plot Context Menu"),
tr("Context Menu was opened at x/y=%1/%2!").arg(x).arg(y),
QMessageBox::Ok,
QMessageBox::Ok); });
}
labMouseAction->setText(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y));
}

2
examples/test_user_interaction/test_user_interaction.h
View File

@ -25,7 +25,7 @@ class TestUserInteraction : public QMainWindow
void setLeftCtrlMouseAction(int index);
void setRightMouseAction(int index);
void setPlotMagnification(int index);
void setRightClickContextMenu(int index);
void setContextMenuMode(int index);
void setLeftDoubleClickMouseAction(int index);
void setRightDoubleClickMouseAction(int index);
void setMouseWheelNoModAction(int index);

87
lib/jkqtplotter/jkqtplotter.cpp
View File

@ -47,7 +47,7 @@ JKQTPlotter::JKQTPlotter(bool datastore_internal, QWidget* parent, JKQTPDatastor
{
initJKQTPlotterResources();
menujkqtpcmmSpecialContextMenu=nullptr;
menuSpecialContextMenu=nullptr;
mouseContextX=0;
mouseContextY=0;
setParent(parent);
@ -89,7 +89,7 @@ JKQTPlotter::JKQTPlotter(bool datastore_internal, QWidget* parent, JKQTPDatastor
toolbar->addSeparator();
populateToolbar(toolbar);
contextMenu=new QMenu(this);
contextMenu=nullptr;//new QMenu(this);
QSize s=QSize(plotterStyle.toolbarIconSize, plotterStyle.toolbarIconSize);
toolbar->setIconSize(s);
@ -114,6 +114,7 @@ JKQTPlotter::JKQTPlotter(QWidget *parent):
}
JKQTPlotter::~JKQTPlotter() {
resetContextMenu(false);
disconnect(plotter, SIGNAL(plotUpdated()), this, SLOT(redrawPlot()));
disconnect(plotter, SIGNAL(overlaysUpdated()), this, SLOT(redrawOverlays()));
disconnect(plotter, SIGNAL(beforePlotScalingRecalculate()), this, SLOT(intBeforePlotScalingRecalculate()));
@ -591,9 +592,7 @@ int JKQTPlotter::getPlotYOffset() {
void JKQTPlotter::initContextMenu()
{
contextMenu->clear();
qDeleteAll(contextSubMenus);
contextSubMenus.clear();
resetContextMenu(true);
contextMenu->addAction(plotter->getActionSaveData());
contextMenu->addAction(plotter->getActionSavePlot());
@ -958,15 +957,15 @@ void JKQTPlotter::setContextMenuMode(JKQTPContextMenuModes mode) {
}
QMenu *JKQTPlotter::getSpecialContextMenu() const {
return this->menujkqtpcmmSpecialContextMenu;
return this->menuSpecialContextMenu;
}
void JKQTPlotter::setSpecialContextMenu(QMenu *menu)
{
menujkqtpcmmSpecialContextMenu=menu;
if (menujkqtpcmmSpecialContextMenu) {
menujkqtpcmmSpecialContextMenu->setParent(this);
menujkqtpcmmSpecialContextMenu->close();
menuSpecialContextMenu=menu;
if (menuSpecialContextMenu) {
menuSpecialContextMenu->setParent(this);
menuSpecialContextMenu->close();
}
}
@ -1081,12 +1080,28 @@ void JKQTPlotter::openStandardContextMenu()
openStandardContextMenu(mouseLastClickX, mouseLastClickY);
}
void JKQTPlotter::resetContextMenu(bool createnew)
{
if (contextMenu) {
contextMenu->close();
contextMenu->clear();
qDeleteAll(contextSubMenus);
contextSubMenus.clear();
delete contextMenu;
if (createnew) {
contextMenu=new QMenu(this);
} else {
contextMenu=nullptr;
}
}
}
void JKQTPlotter::openStandardContextMenu(int x, int y)
{
//qDebug()<<"openContextMenu("<<x<<y<<contextMenu<<")";
mouseContextX=plotter->p2x(x/magnification);
mouseContextY=plotter->p2y((y-getPlotYOffset())/magnification);
contextMenu->close();
initContextMenu();
contextMenu->popup(mapToGlobal(QPoint(x,y)));
//qDebug()<<" -> "<<mapToGlobal(QPoint(x,y))<<contextMenu->size()<<contextMenu->pos()<<contextMenu->parent();
@ -1101,19 +1116,44 @@ void JKQTPlotter::openSpecialContextMenu()
void JKQTPlotter::openSpecialContextMenu(int x, int y)
{
//qDebug()<<"openSpecialContextMenu("<<x<<y<<menujkqtpcmmSpecialContextMenu<<")";
if (menujkqtpcmmSpecialContextMenu) {
for (int i=0; i<menujkqtpcmmSpecialContextMenu->actions().size(); i++) {
//qDebug()<<" - "<<menujkqtpcmmSpecialContextMenu->actions().at(i)->text();
//qDebug()<<"openSpecialContextMenu("<<x<<y<<menuSpecialContextMenu<<")";
if (menuSpecialContextMenu) {
/*
// reset the internal context menu ...
resetContextMenu(true);
// ... and add all actions from the special menu into the new menu: ...
for (int i=0; i<menuSpecialContextMenu->actions().size(); i++) {
//qDebug()<<" - "<<menuSpecialContextMenu->actions().at(i)->text();
contextMenu->addAction(menuSpecialContextMenu->actions().at(i));
}
// ... and copy the basic properties from the other menu
contextMenu->setIcon(menuSpecialContextMenu->icon());
contextMenu->setTitle(menuSpecialContextMenu->title());
contextMenu->setSeparatorsCollapsible(menuSpecialContextMenu->separatorsCollapsible());
contextMenu->setTearOffEnabled(menuSpecialContextMenu->isTearOffEnabled());
contextMenu->setToolTipsVisible(menuSpecialContextMenu->toolTipsVisible());
contextMenu->setFont(menuSpecialContextMenu->font());
contextMenu->setToolTip(menuSpecialContextMenu->toolTip());
contextMenu->setWhatsThis(menuSpecialContextMenu->whatsThis());
contextMenu->setWindowOpacity(menuSpecialContextMenu->windowOpacity());
mouseContextX=plotter->p2x(x/magnification);
mouseContextY=plotter->p2y((y-getPlotYOffset())/magnification);
menujkqtpcmmSpecialContextMenu->close();
menujkqtpcmmSpecialContextMenu->popup(mapToGlobal(QPoint(x,y)));
menujkqtpcmmSpecialContextMenu->resize(menujkqtpcmmSpecialContextMenu->sizeHint());
//qDebug()<<" -> "<<mapToGlobal(QPoint(x,y))<<menujkqtpcmmSpecialContextMenu->size()<<menujkqtpcmmSpecialContextMenu->pos()<<menujkqtpcmmSpecialContextMenu->parent();
emit contextMenuOpened(mouseContextX, mouseContextY, menujkqtpcmmSpecialContextMenu);
//qDebug()<<"openSpecialContextMenu("<<x<<y<<menujkqtpcmmSpecialContextMenu<<") ... DONE";
contextMenu->popup(mapToGlobal(QPoint(x,y)));
contextMenu->resize(contextMenu->sizeHint());
//qDebug()<<" -> "<<mapToGlobal(QPoint(x,y))<<contextMenu->size()<<contextMenu->pos()<<contextMenu->parent();
emit contextMenuOpened(mouseContextX, mouseContextY, contextMenu);
//qDebug()<<"openSpecialContextMenu("<<x<<y<<contextMenu<<") ... DONE";
*/
mouseContextX=plotter->p2x(x/magnification);
mouseContextY=plotter->p2y((y-getPlotYOffset())/magnification);
menuSpecialContextMenu->close();
menuSpecialContextMenu->popup(mapToGlobal(QPoint(x,y)));
menuSpecialContextMenu->resize(menuSpecialContextMenu->sizeHint());
//qDebug()<<" -> "<<mapToGlobal(QPoint(x,y))<<menuSpecialContextMenu->size()<<menuSpecialContextMenu->pos()<<menuSpecialContextMenu->parent();
emit contextMenuOpened(mouseContextX, mouseContextY, menuSpecialContextMenu);
//qDebug()<<"openSpecialContextMenu("<<x<<y<<menuSpecialContextMenu<<") ... DONE";
}
}
@ -1127,12 +1167,11 @@ void JKQTPlotter::openStandardAndSpecialContextMenu(int x, int y)
//qDebug()<<"openContextMenu("<<x<<y<<contextMenu<<")";
mouseContextX=plotter->p2x(x/magnification);
mouseContextY=plotter->p2y((y-getPlotYOffset())/magnification);
contextMenu->close();
initContextMenu();
if (menujkqtpcmmSpecialContextMenu) {
if (menuSpecialContextMenu) {
contextMenu->addSeparator();
for (QAction* act: menujkqtpcmmSpecialContextMenu->actions()) {
for (QAction* act: menuSpecialContextMenu->actions()) {
contextMenu->addAction(act);
}
}

134
lib/jkqtplotter/jkqtplotter.h
View File

@ -167,9 +167,9 @@ JKQTP_LIB_EXPORT void initJKQTPlotterResources();
*
* JKQTPlotter offers a lot of user-interaction features out of the box. These are detailed below.
*
* \subsection JKQTPLOTTER_CONTEXTMENU Conext Menu of JKQTPlotter
* \subsection JKQTPLOTTER_CONTEXTMENU Context Menu of JKQTPlotter
*
* The class JKQTPlotter has a context emnu that already offers a lot of functionality.
* The class JKQTPlotter has a context menu that already offers a lot of functionality.
*
* \image html jkqtplotter_defaultcontextmenu.png
*
@ -196,6 +196,43 @@ JKQTP_LIB_EXPORT void initJKQTPlotterResources();
* <li> switch the visibility of the different graphs in the plot</li>
* </ul>
*
* You can activate this menu, by setting \c setContextMenuMode(jkqtpcmmStandardContextMenu); and binding a mouse-action (typically the right-click)
* to the context menu by calling \c deregisterMouseDragAction(Qt::RightButton,Qt::NoModifier) which deregisters any user actions from the rhs single
* mouse click. In that case, the context menu is opened by default (see setContextMenuMode() to choose the mode of the context menu).
*
*
* In addition JKQTPlotter provides several ways to customize this menu:
* - You can add additional actions to the JKQTPlotter, by calling `JKQTPlotter::addAction()` (i.e. using the default Qt mechanism)
* and/or by adding actions to the internal JKQTBasePlotter, using `JKQTBasePlotter::registerAdditionalAction()`
* - You can modify the menu, when it is displayed, by connecting a slot to the signal `JKQTPlotter::contextMenuOPened(x,y,menu)`:
* \code
* connect(plot, SIGNAL(contextMenuOpened(double, double, QMenu*)), this, SLOT(contextMenuOpened(double, double, QMenu*)));
*
* // ...
*
* void TestUserInteraction::contextMenuOpened(double x, double y, QMenu *contextMenu)
* {
* contextMenu->addSeparator();
* QAction* act=contextMenu->addMenu(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y))->addAction("user-added action");
* connect(act, &QAction::triggered, [x,y]() { QMessageBox::warning(nullptr, tr("Plot Context Menu"),
* tr("Context Menu was opened at x/y=%1/%2!").arg(x).arg(y),
* QMessageBox::Ok,
* QMessageBox::Ok); });
* labMouseAction->setText(QString("contextMenuOpened(x=%1, y=%2)").arg(x).arg(y));
* }
* \endcode
* .
*
* \subsection JKQTPLOTTER_SPECIALCONTEXTMENU Special (User-Defined) Context Menu of JKQTPlotter
*
* In addition to the standard context menu, JKQTPlotter can also be configures to display a special, user-defined context menu.
* To do so, call `\c setContextMenuMode(jkqtpcmmSpecialContextMenu) and set your menu, by calling \c setSpecialContextMenu()
* You can also combine the special menu and the standard menu, by calling \c setContextMenuMode(jkqtpcmmStandardAndSpecialContextMenu) .
*
* You can also use the signal contextMenuOpened() to modify the special context menu, but note that alterations to this menu are permanently
* stored in the special menu object. See contextMenuOpened() for a detailed discussion and ways to circumvent this!
*
*
* \subsection JKQTPLOTTER_TOOLBAR Toolbar of JKQTPlotter
*
* In addition to the context-menu, a JKQtPlotter also also provides a toolbar at its top that offers
@ -295,8 +332,8 @@ JKQTP_LIB_EXPORT void initJKQTPlotterResources();
*
* \subsubsection JKQTPLOTTER_USERMOUSEINTERACTION_MOUSECLICK Actions After (Double-)Clicks on the Mouse Buttons
* The right mouse button has a special role: If it is single-clicked and no JKQTPlotter::MouseActionMode is specified
* for the vent, it opens the context menu, unless you call \c setContextMenuMoode(jkqtpcmmNoContextMenu) .
* You can also use setContextMenuMoode() to specify which type of context menu is shown. See JKQTPContextMenuModes
* for the vent, it opens the context menu, unless you call \c setContextMenuMode(jkqtpcmmNoContextMenu) .
* You can also use setContextMenuMode() to specify which type of context menu is shown. See JKQTPContextMenuModes
* for details on the available modes.
*
* For any mouse-click, one of the following signals is emitted:
@ -624,21 +661,27 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
/** \brief deletes all mouse-wheel actions \see registerMouseWheelAction(), deregisterMouseWheelAction(), \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void clearAllMouseWheelActions();
/*! \brief returns the currently set special context menu object */
/*! \brief returns the currently set special context menu object
*
* \see \ref JKQTPLOTTER_SPECIALCONTEXTMENU, setSpecialContextMenu(), menuSpecialContextMenu, contextMenuOpened(), \ref JKQTPlotterUserInteraction
*/
QMenu *getSpecialContextMenu() const;
/*! \brief sets a QMenu object to be used as special context menu */
/*! \brief sets a QMenu object to be used as special context menu
*
* \see \ref JKQTPLOTTER_SPECIALCONTEXTMENU, getSpecialContextMenu(), menuSpecialContextMenu, contextMenuOpened()
*/
void setSpecialContextMenu(QMenu* menu);
/** \brief x-position of the mouse (in plot coordinates) when a user mouse-action was started (e.g. drawing a rectangle)
*
* \see getMouseContextY(), getMouseLastClickX(), getMouseLastClickY()
* \see \ref JKQTPLOTTER_CONTEXTMENU , getMouseContextY(), getMouseLastClickX(), getMouseLastClickY()
*/
double getMouseContextX() const;
/** \brief y-position of the mouse (in plot coordinates) when a user mouse-action was started (e.g. drawing a rectangle)
*
* \see getMouseContextX(), getMouseLastClickX(), getMouseLastClickY()
* \see \ref JKQTPLOTTER_CONTEXTMENU , getMouseContextX(), getMouseLastClickX(), getMouseLastClickY()
*/
double getMouseContextY() const;
/** \brief x-position of the last mouse-click (in screen pixels)
@ -769,7 +812,7 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
return getConstplotter()->getKeyFontSize();
}
/** \brief returns the currently set mode for the context menu \see JKQTPContextMenuModes, \ref JKQTPLOTTER_USERMOUSEINTERACTION */
/** \brief returns the currently set mode for the context menu \see JKQTPContextMenuModes, \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_SPECIALCONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION */
JKQTPContextMenuModes getContextMenuMode() const;
/** \brief current style properties for this JKQTPlotter
@ -918,7 +961,7 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
* \see getUserActionCompositionMode(), JKQTPlotterStyle::userActionColor \ref JKQTPLOTTER_USERMOUSEINTERACTION_MOUSEDRAG */
void setUserActionCompositionMode(const QPainter::CompositionMode & __value);
/** \brief sets the mode if the standard context menu \see JKQTPContextMenuModes, \ref JKQTPLOTTER_USERMOUSEINTERACTION */
/** \brief sets the mode if the standard context menu \see JKQTPContextMenuModes, \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_SPECIALCONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void setContextMenuMode(JKQTPContextMenuModes mode);
/** \brief may be connected to zoomChangedLocally() of a different plot and synchronizes the local x-axis to the other x-axis \see \ref JKQTBASEPLOTTER_SYNCMULTIPLOT */
@ -935,23 +978,23 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
*/
void populateToolbar(QToolBar* toolbar) const;
/** \brief open the context menu at the mouse position of the last click */
/** \brief open the context menu at the mouse position of the last click \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openContextMenu();
/** \brief open the context menu at the mouse position \a x and \a y */
/** \brief open the context menu at the mouse position \a x and \a y \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openContextMenu(int x, int y);
/** \brief open the standard context menu at the mouse position of the last click */
/** \brief open the standard context menu at the mouse position of the last click \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openStandardContextMenu();
/** \brief open the standard context menu at the mouse position \a x and \a y */
/** \brief open the standard context menu at the mouse position \a x and \a y \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openStandardContextMenu(int x, int y);
/** \brief open the special context menu at the mouse position of the last click */
/** \brief open the special context menu at the mouse position of the last click \see \ref JKQTPLOTTER_SPECIALCONTEXTMENU, \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openSpecialContextMenu();
/** \brief open the special context menu at the mouse position \a x and \a y */
/** \brief open the special context menu at the mouse position \a x and \a y \see \ref JKQTPLOTTER_SPECIALCONTEXTMENU, \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openSpecialContextMenu(int x, int y);
/** \brief open the standard context menu with the special context menu integrated at the mouse position of the last click */
/** \brief open the standard context menu with the special context menu integrated at the mouse position of the last click \see \ref JKQTPLOTTER_SPECIALCONTEXTMENU, \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openStandardAndSpecialContextMenu();
/** \brief open the standard context menu with the special context menu integrated at the mouse position \a x and \a y */
/** \brief open the standard context menu with the special context menu integrated at the mouse position \a x and \a y \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_SPECIALCONTEXTMENU, \ref JKQTPLOTTER_USERMOUSEINTERACTION */
void openStandardAndSpecialContextMenu(int x, int y);
/** \brief sets absolutely limiting x-range of the plot
@ -1099,6 +1142,27 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
* QMessageBox::Ok,
* QMessageBox::Ok); });
* \endcode
* <b>Please read the warning below!!!</b>
*
* \warning A note of care: This signal can be used to alter the context menu. It behaves differently, depending on
* whether you use the standard context menu, or the special context menu (setSpecialContextMenu()). If the
* standard menu is opened, your alterations are valid until it is shown the next time (i.e. the internal
* context menu object is deleted in between). If you show the special context menu only, your alterations
* are <b>permanently stored</b> in the menu object. I.e. if you use the code example above and open the menu
* several times, it will accumulate additional menu entries!
* If you must modify the special menu, just access actions and do not add or delete any in a slot bound to
* this signal! You can recognize the special menu with code like this:
* \code
* if (contextMenu == plot->getSpecialContextMenu()) {
* //...
* // do something with the special menu, do not add/remove entries
* } else {
* //...
* // do something with the standard menu, you are free to do anything!
* }
* \endcode
*
* \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_SPECIALCONTEXTMENU, \ref JKQTPLOTTER_USERMOUSEINTERACTION
*/
void contextMenuOpened(double x, double y, QMenu* contextMenu);
@ -1193,9 +1257,11 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
/** \brief searches JKQTPlotterStyle::registeredMouseDoubleClickActions for a matching action */
JKQTPMouseDoubleClickActionsHashMapIterator findMatchingMouseDoubleClickAction(Qt::MouseButton button, Qt::KeyboardModifiers modifiers) const;
/** \brief you may overwrite this method to modify the given context emnu before it is displayed.
/** \brief you may overwrite this method to modify the given context menu before it is displayed.
*
* The plotter will fill the menu with the default items and then call this method. The default implementation does NOTHING.
*
* \see \ref JKQTPLOTTER_CONTEXTMENU , \ref JKQTPLOTTER_USERMOUSEINTERACTION
*/
void modifyContextMenu(QMenu* menu);
@ -1257,8 +1323,10 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
QImage oldImage;
/** \brief use this QMenu instance instead of the standard context emnu of this widget */
QMenu* menujkqtpcmmSpecialContextMenu;
/** \brief use this QMenu instance instead of the standard context menu of this widget
* \see \ref JKQTPLOTTER_SPECIALCONTEXTMENU
*/
QMenu* menuSpecialContextMenu;
@ -1350,9 +1418,14 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
/** \brief current minimal size of the JKQTPlotter widget to properly display the plot */
QSize minSize;
/** \brief the context menu object used by this JKQTPlotter */
/** \brief the context menu object used by this JKQTPlotter
*
* \note this might be \c ==nullptr occasionally, therefore you need to check it, before accessing it!
*
* \see \ref JKQTPLOTTER_CONTEXTMENU , resetContextMenu(), initContextMenu(), contextMenuMode
*/
QMenu* contextMenu;
/** \brief current mode for the default context menu (i.e. the right-click context menu) */
/** \brief current mode for the default context menu (i.e. the right-click context menu) \see \ref JKQTPLOTTER_CONTEXTMENU */
JKQTPContextMenuModes contextMenuMode;
/** \brief x-position of the mouse (in plot coordinates) when a user mouse-action was started (e.g. drawing a rectangle) */
double mouseContextX;
@ -1363,7 +1436,12 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
/** \brief y-position of the last mouse-click (in screen pixels) */
int mouseLastClickY;
QList<QMenu*> contextSubMenus;
/** \brief fills the member contextMenu with all default and additionally registered actions, also calls modifyContextMenu() */
/** \brief fills the member contextMenu with all default and additionally registered actions, also calls modifyContextMenu()
*
* \note This function calls resetContextMenu() internally!
*
* \see resetContextMenu(), contextMenuMode
*/
void initContextMenu();
/** \brief set the current mouse cursor shappe according to currentMouseDragAction */
void updateCursor();
@ -1383,6 +1461,14 @@ class JKQTP_LIB_EXPORT JKQTPlotter: public QWidget {
*/
QTimer resizeTimer;
/** \brief destroys the internal contextMenu and optionally creates a new one
*
* \param createnew if \c ==true, contextMenu is reinitialized with a (shiny) new QMenu,
* otherwise it is set to \c nullptr after destroying the old menu.
*
* \see initContextMenu(), contextMenuMode
*/
void resetContextMenu(bool createnew=true);
protected slots:
/** \brief while the window is resized, the plot is only redrawn after a restartable delay, implemented by this function and resizeTimer
* \internal