qgspanelwidget.cpp

Go to the documentation of this file.

/***************************************************************************
    qgspanelwidget.cpp
    ---------------------
    begin                : June 2016
    copyright            : (C) 2016 by Nathan Woodrow
    email                :
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#include "qgspanelwidget.h"
 
#include "qgslogger.h"
#include "qgssettings.h"
 
#include <QDialog>
#include <QDialogButtonBox>
#include <QPushButton>
#include <QString>
#include <QVBoxLayout>
 
#include "moc_qgspanelwidget.cpp"
 
using namespace Qt::StringLiterals;
 
QgsPanelWidget::QgsPanelWidget( QWidget *parent )
  : QWidget( parent )
{
  // Forward the changed signal to the deprecated one, for backwards compatibility.
  // TODO QGIS 5.0 remove
  Q_NOWARN_DEPRECATED_PUSH
  connect( this, &QgsPanelWidget::changed, this, [this] {
    if ( mForwardChangedSignal )
    {
      return;
    }
    mForwardChangedSignal = true;
    emit widgetChanged();
    mForwardChangedSignal = false;
  } );
 
  // Forward the deprecated signal to the new one for subclasses which still use the deprecated one
  connect( this, &QgsPanelWidget::widgetChanged, this, [this] {
    if ( mForwardChangedSignal )
    {
      return;
    }
    mForwardChangedSignal = true;
    emit changed();
    mForwardChangedSignal = false;
  } );
  Q_NOWARN_DEPRECATED_POP
}
 
void QgsPanelWidget::connectChildPanels( const QList<QgsPanelWidget *> &panels )
{
  const auto constPanels = panels;
  for ( QgsPanelWidget *widget : constPanels )
  {
    connectChildPanel( widget );
  }
}
 
void QgsPanelWidget::connectChildPanel( QgsPanelWidget *panel )
{
  connect( panel, &QgsPanelWidget::showPanel, this, &QgsPanelWidget::openPanel );
  connect( panel, &QgsPanelWidget::changed, this, &QgsPanelWidget::changed );
}
 
void QgsPanelWidget::setDockMode( bool dockMode )
{
  mDockMode = dockMode;
}
 
bool QgsPanelWidget::applySizeConstraintsToStack() const
{
  return false;
}
 
QgsPanelWidget *QgsPanelWidget::findParentPanel( QWidget *widget )
{
  QWidget *p = widget;
  while ( p )
  {
    if ( QgsPanelWidget *panel = qobject_cast<QgsPanelWidget *>( p ) )
      return panel;
 
    if ( p->window() == p )
    {
      // break on encountering a window - e.g., a dialog opened from a panel should not inline
      // widgets inside the parent panel
      return nullptr;
    }
 
    p = p->parentWidget();
  }
  return nullptr;
}
 
QString QgsPanelWidget::menuButtonTooltip() const
{
  return QString();
}
 
QMenu *QgsPanelWidget::menuButtonMenu()
{
  return nullptr;
}
 
void QgsPanelWidget::openPanel( QgsPanelWidget *panel )
{
  //panel dock mode inherits from this panel
  panel->setDockMode( dockMode() );
 
  if ( mDockMode )
  {
    emit showPanel( panel );
  }
  else
  {
    // Show the dialog version if no one is connected
    QDialog *dlg = new QDialog();
    const QString key = u"/UI/paneldialog/%1"_s.arg( panel->panelTitle() );
    QgsSettings settings;
    dlg->restoreGeometry( settings.value( key ).toByteArray() );
    dlg->setWindowTitle( panel->panelTitle() );
    dlg->setLayout( new QVBoxLayout() );
    dlg->layout()->addWidget( panel );
    QDialogButtonBox *buttonBox = new QDialogButtonBox( QDialogButtonBox::Ok );
    connect( buttonBox, &QDialogButtonBox::accepted, dlg, &QDialog::accept );
    dlg->layout()->addWidget( buttonBox );
    dlg->exec();
    settings.setValue( key, dlg->saveGeometry() );
    panel->acceptPanel();
  }
}
 
void QgsPanelWidget::acceptPanel()
{
  emit panelAccepted( this );
}
 
void QgsPanelWidget::keyPressEvent( QKeyEvent *event )
{
  if ( event->key() == Qt::Key_Escape )
  {
    acceptPanel();
  }
  else
  {
    QWidget::keyPressEvent( event );
  }
}
 
QgsPanelWidgetWrapper::QgsPanelWidgetWrapper( QWidget *widget, QWidget *parent )
  : QgsPanelWidget( parent )
  , mWidget( widget )
{
  this->setLayout( new QVBoxLayout() );
  this->layout()->setContentsMargins( 0, 0, 0, 0 );
  this->layout()->addWidget( widget );
}