QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
qgslayoutnewitempropertiesdialog.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutnewitempropertiesdialog.cpp
3  ------------------------------------
4  Date : July 2017
5  Copyright : (C) 2017 Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
17 #include "qgssettings.h"
18 #include "qgslayout.h"
20 #include "qgshelp.h"
21 #include "qgsgui.h"
22 
23 #include <QButtonGroup>
24 
25 QgsLayoutItemPropertiesDialog::QgsLayoutItemPropertiesDialog( QWidget *parent, Qt::WindowFlags flags )
26  : QDialog( parent, flags )
27 {
28  setupUi( this );
29 
31 
32  //make button exclusive
33  QButtonGroup *buttonGroup = new QButtonGroup( this );
34  buttonGroup->addButton( mUpperLeftRadioButton );
35  buttonGroup->addButton( mUpperMiddleRadioButton );
36  buttonGroup->addButton( mUpperRightRadioButton );
37  buttonGroup->addButton( mMiddleLeftRadioButton );
38  buttonGroup->addButton( mMiddleRadioButton );
39  buttonGroup->addButton( mMiddleRightRadioButton );
40  buttonGroup->addButton( mLowerLeftRadioButton );
41  buttonGroup->addButton( mLowerMiddleRadioButton );
42  buttonGroup->addButton( mLowerRightRadioButton );
43  buttonGroup->setExclusive( true );
44 
45  QgsSettings settings;
46  double lastWidth = settings.value( QStringLiteral( "LayoutDesigner/lastItemWidth" ), QStringLiteral( "50" ) ).toDouble();
47  double lastHeight = settings.value( QStringLiteral( "LayoutDesigner/lastItemHeight" ), QStringLiteral( "50" ) ).toDouble();
48  QgsUnitTypes::LayoutUnit lastSizeUnit = settings.enumValue( QStringLiteral( "LayoutDesigner/lastSizeUnit" ), QgsUnitTypes::LayoutMillimeters );
49  setItemSize( QgsLayoutSize( lastWidth, lastHeight, lastSizeUnit ) );
50 
51  mPosUnitsComboBox->linkToWidget( mXPosSpin );
52  mPosUnitsComboBox->linkToWidget( mYPosSpin );
53  mSizeUnitsComboBox->linkToWidget( mWidthSpin );
54  mSizeUnitsComboBox->linkToWidget( mHeightSpin );
55 
56  mLockAspectRatio->setWidthSpinBox( mWidthSpin );
57  mLockAspectRatio->setHeightSpinBox( mHeightSpin );
58 
59  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsLayoutItemPropertiesDialog::showHelp );
60 }
61 
63 {
64  // page number
65  QPointF layoutPoint = mLayout->convertToLayoutUnits( position );
66  int page = mLayout->pageCollection()->pageNumberForPoint( layoutPoint );
67 
68  // convert position to relative for current page
69  position = mLayout->convertFromLayoutUnits( mLayout->pageCollection()->positionOnPage( layoutPoint ), position.units() );
70 
71  mPageSpin->setValue( page + 1 );
72  whileBlocking( mPosUnitsComboBox )->setUnit( position.units() );
73  mXPosSpin->setValue( position.x() );
74  mYPosSpin->setValue( position.y() );
75 }
76 
78 {
79  return QgsLayoutPoint( mXPosSpin->value(), mYPosSpin->value(), mPosUnitsComboBox->unit() );
80 }
81 
83 {
84  return mPageSpin->value() - 1;
85 }
86 
88 {
89  mWidthSpin->setValue( size.width() );
90  mHeightSpin->setValue( size.height() );
91  whileBlocking( mSizeUnitsComboBox )->setUnit( size.units() );
92 }
93 
95 {
96  return QgsLayoutSize( mWidthSpin->value(), mHeightSpin->value(), mSizeUnitsComboBox->unit() );
97 }
98 
100 {
101  if ( mUpperLeftRadioButton->isChecked() )
102  {
104  }
105  else if ( mUpperMiddleRadioButton->isChecked() )
106  {
108  }
109  else if ( mUpperRightRadioButton->isChecked() )
110  {
112  }
113  else if ( mMiddleLeftRadioButton->isChecked() )
114  {
116  }
117  else if ( mMiddleRadioButton->isChecked() )
118  {
119  return QgsLayoutItem::Middle;
120  }
121  else if ( mMiddleRightRadioButton->isChecked() )
122  {
124  }
125  else if ( mLowerLeftRadioButton->isChecked() )
126  {
128  }
129  else if ( mLowerMiddleRadioButton->isChecked() )
130  {
132  }
133  else if ( mLowerRightRadioButton->isChecked() )
134  {
136  }
138 }
139 
141 {
142  switch ( point )
143  {
145  mUpperLeftRadioButton->setChecked( true );
146  break;
147 
149  mUpperMiddleRadioButton->setChecked( true );
150  break;
151 
153  mUpperRightRadioButton->setChecked( true );
154  break;
155 
157  mMiddleLeftRadioButton->setChecked( true );
158  break;
159 
161  mMiddleRadioButton->setChecked( true );
162  break;
163 
165  mMiddleRightRadioButton->setChecked( true );
166  break;
167 
169  mLowerLeftRadioButton->setChecked( true );
170  break;
171 
173  mLowerMiddleRadioButton->setChecked( true );
174  break;
175 
177  mLowerRightRadioButton->setChecked( true );
178  break;
179  }
180 }
181 
183 {
184  mSizeUnitsComboBox->setConverter( &layout->renderContext().measurementConverter() );
185  mPosUnitsComboBox->setConverter( &layout->renderContext().measurementConverter() );
186  mLayout = layout;
187 }
188 
189 void QgsLayoutItemPropertiesDialog::showHelp()
190 {
191  QgsHelp::openHelp( QStringLiteral( "print_composer/composer_items/composer_items_options.html#creating-a-layout-item" ) );
192 }
void setItemPosition(QgsLayoutPoint position)
Sets the item position to show in the dialog.
Lower left corner of item.
This class is a composition of two QSettings instances:
Definition: qgssettings.h:58
int pageNumberForPoint(QPointF point) const
Returns the page number corresponding to a point in the layout (in layout units). ...
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void setReferencePoint(QgsLayoutItem::ReferencePoint point)
Sets the item reference point defined to show in the dialog.
Upper center of item.
void setLayout(QgsLayout *layout)
Sets the layout associated with the dialog.
Lower right corner of item.
QgsLayoutRenderContext & renderContext()
Returns a reference to the layout&#39;s render context, which stores information relating to the current ...
Definition: qgslayout.cpp:358
QgsLayoutItemPropertiesDialog(QWidget *parent=nullptr, Qt::WindowFlags flags=nullptr)
Constructor for QgsLayoutNewItemPropertiesDialog.
This class provides a method of storing points, consisting of an x and y coordinate, for use in QGIS layouts.
ReferencePoint
Fixed position reference point.
QgsUnitTypes::LayoutUnit units() const
Returns the units for the point.
Upper right corner of item.
QgsLayoutPoint itemPosition() const
Returns the current item position defined by the dialog.
Lower center of item.
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout&#39;s page collection, which stores and manages page items in the layout...
Definition: qgslayout.cpp:458
Middle right of item.
double y() const
Returns y coordinate of point.
QgsLayoutItem::ReferencePoint referencePoint() const
Returns the item reference point defined by the dialog.
double x() const
Returns x coordinate of point.
QgsUnitTypes::LayoutUnit units() const
Returns the units for the size.
Upper left corner of item.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
Middle left of item.
QPointF positionOnPage(QPointF point) const
Returns the position within a page of a point in the layout (in layout units).
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition: qgis.h:227
const QgsLayoutMeasurementConverter & measurementConverter() const
Returns the layout measurement converter to be used in the layout.
Center of item.
QgsLayoutSize itemSize() const
Returns the item size defined by the dialog.
QgsLayoutMeasurement convertFromLayoutUnits(double length, QgsUnitTypes::LayoutUnit unit) const
Converts a length measurement from the layout&#39;s native units to a specified target unit...
Definition: qgslayout.cpp:343
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
Definition: qgsgui.cpp:127
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition: qgshelp.cpp:36
T enumValue(const QString &key, const T &defaultValue, const Section section=NoSection)
Returns the setting value for a setting based on an enum.
Definition: qgssettings.h:244
LayoutUnit
Layout measurement units.
Definition: qgsunittypes.h:159
double convertToLayoutUnits(QgsLayoutMeasurement measurement) const
Converts a measurement into the layout&#39;s native units.
Definition: qgslayout.cpp:328
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Definition: qgslayoutsize.h:40
double height() const
Returns the height of the size.
Definition: qgslayoutsize.h:90
int page() const
Returns the page number for the new item.
void setItemSize(QgsLayoutSize size)
Sets the item size to show in the dialog.
double width() const
Returns the width of the size.
Definition: qgslayoutsize.h:76