-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgscollapsiblegroupbox.cpp
562 lines (486 loc) · 17 KB
/
qgscollapsiblegroupbox.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
/***************************************************************************
qgscollapsiblegroupbox.cpp
-------------------
begin : August 2012
copyright : (C) 2012 by Etienne Tourigny
email : etourigny dot dev at gmail dot com
***************************************************************************/
/***************************************************************************
* *
* 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 "qgscollapsiblegroupbox.h"
#include "qgsapplication.h"
#include "qgslogger.h"
#include <QToolButton>
#include <QMouseEvent>
#include <QPushButton>
#include <QStyleOptionGroupBox>
#include <QSettings>
#include <QScrollArea>
QIcon QgsCollapsibleGroupBoxBasic::mCollapseIcon;
QIcon QgsCollapsibleGroupBoxBasic::mExpandIcon;
QgsCollapsibleGroupBoxBasic::QgsCollapsibleGroupBoxBasic( QWidget *parent )
: QGroupBox( parent )
{
init();
}
QgsCollapsibleGroupBoxBasic::QgsCollapsibleGroupBoxBasic( const QString &title,
QWidget *parent )
: QGroupBox( title, parent )
{
init();
}
QgsCollapsibleGroupBoxBasic::~QgsCollapsibleGroupBoxBasic()
{
//QgsDebugMsg( "Entered" );
}
void QgsCollapsibleGroupBoxBasic::init()
{
//QgsDebugMsg( "Entered" );
// variables
mCollapsed = false;
mInitFlat = false;
mInitFlatChecked = false;
mScrollOnExpand = true;
mShown = false;
mParentScrollArea = 0;
mSyncParent = 0;
mSyncGroup = "";
mAltDown = false;
mTitleClicked = false;
// init icons
if ( mCollapseIcon.isNull() )
{
mCollapseIcon = QgsApplication::getThemeIcon( "/mIconCollapse.png" );
mExpandIcon = QgsApplication::getThemeIcon( "/mIconExpand.png" );
}
// collapse button
mCollapseButton = new QgsGroupBoxCollapseButton( this );
mCollapseButton->setObjectName( "collapseButton" );
mCollapseButton->setAutoRaise( true );
mCollapseButton->setFixedSize( 16, 16 );
// TODO set size (as well as margins) depending on theme, in updateStyle()
mCollapseButton->setIconSize( QSize( 12, 12 ) );
mCollapseButton->setIcon( mCollapseIcon );
connect( mCollapseButton, SIGNAL( clicked() ), this, SLOT( toggleCollapsed() ) );
connect( this, SIGNAL( toggled( bool ) ), this, SLOT( checkToggled( bool ) ) );
}
void QgsCollapsibleGroupBoxBasic::showEvent( QShowEvent * event )
{
//QgsDebugMsg( "Entered" );
// initialise widget on first show event only
if ( mShown )
{
event->accept();
return;
}
// check if groupbox was set to flat in Designer or in code
if ( !mInitFlatChecked )
{
mInitFlat = isFlat();
mInitFlatChecked = true;
}
// find parent QScrollArea - this might not work in complex layouts - should we look deeper?
if ( parent() && parent()->parent() )
mParentScrollArea = dynamic_cast<QScrollArea*>( parent()->parent()->parent() );
else
mParentScrollArea = 0;
if ( mParentScrollArea )
{
QgsDebugMsg( "found a QScrollArea parent: " + mParentScrollArea->objectName() );
}
else
{
QgsDebugMsg( "did not find a QScrollArea parent" );
}
updateStyle();
// expand if needed - any calls to setCollapsed() before only set mCollapsed, but have UI effect
if ( mCollapsed )
{
setCollapsed( mCollapsed );
}
else
{
// emit signal for connections using collapsed state
emit collapsedStateChanged( isCollapsed() );
}
// verify triangle mirrors groupbox's enabled state
mCollapseButton->setEnabled( isEnabled() );
// set mShown after first setCollapsed call or expanded groupboxes
// will scroll scroll areas when first shown
mShown = true;
event->accept();
}
void QgsCollapsibleGroupBoxBasic::mousePressEvent( QMouseEvent *event )
{
// avoid leaving checkbox in pressed state if alt-clicking
if ( event->modifiers() & Qt::AltModifier
&& titleRect().contains( event->pos() )
&& isCheckable() )
{
event->ignore();
return;
}
// default behaviour - pass to QGroupBox
QGroupBox::mousePressEvent( event );
}
void QgsCollapsibleGroupBoxBasic::mouseReleaseEvent( QMouseEvent *event )
{
mAltDown = ( event->modifiers() & ( Qt::AltModifier | Qt::ControlModifier ) );
mTitleClicked = ( titleRect().contains( event->pos() ) );
// sync group when title is alt-clicked
// collapse/expand when title is clicked and non-checkable
if ( event->button() == Qt::LeftButton && mTitleClicked &&
( mAltDown || !isCheckable() ) )
{
toggleCollapsed();
return;
}
// default behaviour - pass to QGroupBox
QGroupBox::mouseReleaseEvent( event );
}
void QgsCollapsibleGroupBoxBasic::changeEvent( QEvent *event )
{
// always re-enable mCollapseButton when groupbox was previously disabled
// e.g. resulting from a disabled parent of groupbox, or a signal/slot connection
// default behaviour - pass to QGroupBox
QGroupBox::changeEvent( event );
if ( event->type() == QEvent::EnabledChange && isEnabled() )
mCollapseButton->setEnabled( true );
}
void QgsCollapsibleGroupBoxBasic::setSyncGroup( QString grp )
{
mSyncGroup = grp;
if ( !grp.isEmpty() )
{
mCollapseButton->setToolTip( tr( "Ctrl(or Alt)-click to toggle all" ) );
}
else
{
mCollapseButton->setToolTip( QString( "" ) );
}
}
QRect QgsCollapsibleGroupBoxBasic::titleRect() const
{
QStyleOptionGroupBox box;
initStyleOption( &box );
return style()->subControlRect( QStyle::CC_GroupBox, &box,
QStyle::SC_GroupBoxLabel, this );
}
void QgsCollapsibleGroupBoxBasic::checkToggled( bool chkd )
{
mCollapseButton->setEnabled( true ); // always keep enabled
// expand/collapse when toggled
if ( chkd && isCollapsed() )
setCollapsed( false );
else if ( ! chkd && ! isCollapsed() )
setCollapsed( true );
}
void QgsCollapsibleGroupBoxBasic::toggleCollapsed()
{
// verify if sender is this group box's collapse button
bool senderCollBtn = false;
QgsGroupBoxCollapseButton* collBtn = qobject_cast<QgsGroupBoxCollapseButton*>( QObject::sender() );
senderCollBtn = ( collBtn && collBtn == mCollapseButton );
// find any sync group siblings and toggle them
if ((( senderCollBtn && mCollapseButton->altDown() ) || ( mTitleClicked && mAltDown ) )
&& !mSyncGroup.isEmpty() )
{
mCollapseButton->setAltDown( false );
mAltDown = false;
QgsDebugMsg( "Alt key down, syncing group" );
// get pointer to parent or grandparent widget
if ( parentWidget() )
{
mSyncParent = parentWidget();
if ( mSyncParent->parentWidget() )
{
// don't use whole app for grandparent (common for dialogs that use main window for parent)
if ( mSyncParent->parentWidget()->objectName() != QString( "QgisApp" ) )
{
mSyncParent = mSyncParent->parentWidget();
}
}
}
else
{
mSyncParent = 0;
}
if ( mSyncParent )
{
QgsDebugMsg( "found sync parent: " + mSyncParent->objectName() );
bool thisCollapsed = mCollapsed; // get state of current box before its changed
foreach ( QgsCollapsibleGroupBoxBasic *grpbox, mSyncParent->findChildren<QgsCollapsibleGroupBoxBasic*>() )
{
if ( grpbox->syncGroup() == syncGroup() && grpbox->isEnabled() )
{
grpbox->setCollapsed( !thisCollapsed );
}
}
return;
}
else
{
QgsDebugMsg( "did not find a sync parent" );
}
}
setCollapsed( !mCollapsed );
}
void QgsCollapsibleGroupBoxBasic::updateStyle()
{
setUpdatesEnabled( false );
QSettings settings;
// NOTE: QGIS-Style groupbox styled in app stylesheet
bool usingQgsStyle = settings.value( "qgis/stylesheet/groupBoxCustom", QVariant( false ) ).toBool();
QStyleOptionGroupBox box;
initStyleOption( &box );
QRect rectFrame = style()->subControlRect( QStyle::CC_GroupBox, &box,
QStyle::SC_GroupBoxFrame, this );
QRect rectTitle = titleRect();
// margin/offset defaults
int marginLeft = 20; // title margin for disclosure triangle
int marginRight = 5; // a little bit of space on the right, to match space on the left
int offsetLeft = 0; // offset for oxygen theme
int offsetStyle = QApplication::style()->objectName().contains( "macintosh" ) ? 1 : 0;
int topBuffer = ( usingQgsStyle ? 3 : 1 ) + offsetStyle; // space between top of title or triangle and widget above
int offsetTop = topBuffer;
int offsetTopTri = topBuffer; // offset for triangle
if ( mCollapseButton->height() < rectTitle.height() ) // triangle's height > title text's, offset triangle
{
offsetTopTri += ( rectTitle.height() - mCollapseButton->height() ) / 2 ;
// offsetTopTri += rectTitle.top();
}
else if ( rectTitle.height() < mCollapseButton->height() ) // title text's height < triangle's, offset title
{
offsetTop += ( mCollapseButton->height() - rectTitle.height() ) / 2;
}
// calculate offset if frame overlaps triangle (oxygen theme)
// using an offset of 6 pixels from frame border
if ( QApplication::style()->objectName().toLower() == "oxygen" )
{
QStyleOptionGroupBox box;
initStyleOption( &box );
QRect rectFrame = style()->subControlRect( QStyle::CC_GroupBox, &box,
QStyle::SC_GroupBoxFrame, this );
QRect rectCheckBox = style()->subControlRect( QStyle::CC_GroupBox, &box,
QStyle::SC_GroupBoxCheckBox, this );
if ( rectFrame.left() <= 0 )
offsetLeft = 6 + rectFrame.left();
if ( rectFrame.top() <= 0 )
{
if ( isCheckable() )
{
// if is checkable align with checkbox
offsetTop = ( rectCheckBox.height() / 2 ) -
( mCollapseButton->height() / 2 ) + rectCheckBox.top();
offsetTopTri = offsetTop + 1;
}
else
{
offsetTop = 6 + rectFrame.top();
offsetTopTri = offsetTop;
}
}
}
QgsDebugMsg( QString( "groupbox: %1 style: %2 offset: left=%3 top=%4 top2=%5" ).arg(
objectName() ).arg( QApplication::style()->objectName() ).arg( offsetLeft ).arg( offsetTop ).arg( offsetTopTri ) );
// customize style sheet for collapse/expand button and force left-aligned title
QString ss;
if ( usingQgsStyle || QApplication::style()->objectName().contains( "macintosh" ) )
{
ss += "QgsCollapsibleGroupBoxBasic, QgsCollapsibleGroupBox {";
ss += QString( " margin-top: %1px;" ).arg( topBuffer + ( usingQgsStyle ? rectTitle.height() + 5 : rectFrame.top() ) );
ss += "}";
}
ss += "QgsCollapsibleGroupBoxBasic::title, QgsCollapsibleGroupBox::title {";
ss += " subcontrol-origin: margin;";
ss += " subcontrol-position: top left;";
ss += QString( " margin-left: %1px;" ).arg( marginLeft );
ss += QString( " margin-right: %1px;" ).arg( marginRight );
ss += QString( " left: %1px;" ).arg( offsetLeft );
ss += QString( " top: %1px;" ).arg( offsetTop );
ss += "}";
setStyleSheet( ss );
// clear toolbutton default background and border and apply offset
QString ssd;
ssd = QString( "QgsCollapsibleGroupBoxBasic > QToolButton#%1, QgsCollapsibleGroupBox > QToolButton#%1 {" ).arg( mCollapseButton->objectName() );
ssd += " background-color: rgba(255, 255, 255, 0); border: none;";
ssd += "}";
mCollapseButton->setStyleSheet( ssd );
if ( offsetLeft != 0 || offsetTopTri != 0 )
mCollapseButton->move( offsetLeft, offsetTopTri );
setUpdatesEnabled( true );
}
void QgsCollapsibleGroupBoxBasic::setCollapsed( bool collapse )
{
mCollapsed = collapse;
if ( !isVisible() )
return;
// for consistent look/spacing across platforms when collapsed
if ( ! mInitFlat ) // skip if initially set to flat in Designer
setFlat( collapse );
// avoid flicker in X11
// NOTE: this causes app to crash when loading a project that hits a group box with
// 'collapse' set via dynamic property or in code (especially if auto-launching project)
// TODO: find another means of avoiding the X11 flicker
// QApplication::processEvents();
// handle QPushButtons in form layouts that stay visible on collapse (Qt bug)
// set flat on collapse for fix, but preserve button's flat value when expanding
if ( collapse )
{
foreach ( QPushButton* pBtn, findChildren<QPushButton *>() )
{
if ( ! pBtn->isFlat() )
{
if ( ! pBtn->property( "PushButtonFlat" ).isValid() )
pBtn->setProperty( "PushButtonFlat", QVariant( false ) );
pBtn->setFlat( true );
}
}
}
else
{
foreach ( QPushButton* pBtn, findChildren<QPushButton *>() )
{
// restore any previous flat value
if ( pBtn->property( "PushButtonFlat" ).isValid() )
pBtn->setFlat( false );
}
}
// set maximum height to hide contents - does this work in all envs?
// setMaximumHeight( collapse ? 25 : 16777215 );
setMaximumHeight( collapse ? titleRect().bottom() + 6 : 16777215 );
mCollapseButton->setIcon( collapse ? mExpandIcon : mCollapseIcon );
// if expanding and is in a QScrollArea, scroll down to make entire widget visible
if ( mShown && mScrollOnExpand && !collapse && mParentScrollArea )
{
// process events so entire widget is shown
QApplication::processEvents();
mParentScrollArea->ensureWidgetVisible( this );
}
// emit signal for connections using collapsed state
emit collapsedStateChanged( isCollapsed() );
}
// ----
QgsCollapsibleGroupBox::QgsCollapsibleGroupBox( QWidget *parent, QSettings* settings )
: QgsCollapsibleGroupBoxBasic( parent ), mSettings( settings )
{
init();
}
QgsCollapsibleGroupBox::QgsCollapsibleGroupBox( const QString &title,
QWidget *parent, QSettings* settings )
: QgsCollapsibleGroupBoxBasic( title, parent ), mSettings( settings )
{
init();
}
QgsCollapsibleGroupBox::~QgsCollapsibleGroupBox()
{
//QgsDebugMsg( "Entered" );
saveState();
if ( mDelSettings ) // local settings obj to delete
delete mSettings;
mSettings = 0; // null the pointer (in case of outside settings obj)
}
void QgsCollapsibleGroupBox::setSettings( QSettings* settings )
{
if ( mDelSettings ) // local settings obj to delete
delete mSettings;
mSettings = settings;
mDelSettings = false; // don't delete outside obj
}
void QgsCollapsibleGroupBox::init()
{
//QgsDebugMsg( "Entered" );
// use pointer to app qsettings if no custom qsettings specified
// custom qsettings object may be from Python plugin
mDelSettings = false;
if ( !mSettings )
{
mSettings = new QSettings();
mDelSettings = true; // only delete obj created by class
}
// variables
mSaveCollapsedState = true;
// NOTE: only turn on mSaveCheckedState for groupboxes NOT used
// in multiple places or used as options for different parent objects
mSaveCheckedState = false;
mSettingGroup = ""; // if not set, use window object name
}
void QgsCollapsibleGroupBox::showEvent( QShowEvent * event )
{
//QgsDebugMsg( "Entered" );
// initialise widget on first show event only
if ( mShown )
{
event->accept();
return;
}
// check if groupbox was set to flat in Designer or in code
if ( !mInitFlatChecked )
{
mInitFlat = isFlat();
mInitFlatChecked = true;
}
loadState();
QgsCollapsibleGroupBoxBasic::showEvent( event );
}
QString QgsCollapsibleGroupBox::saveKey() const
{
// save key for load/save state
// currently QgsCollapsibleGroupBox/window()/object
QString saveKey = "/" + objectName();
// QObject* parentWidget = parent();
// while ( parentWidget != NULL )
// {
// saveKey = "/" + parentWidget->objectName() + saveKey;
// parentWidget = parentWidget->parent();
// }
// if ( parent() != NULL )
// saveKey = "/" + parent()->objectName() + saveKey;
QString setgrp = mSettingGroup.isEmpty() ? window()->objectName() : mSettingGroup;
saveKey = "/" + setgrp + saveKey;
saveKey = "QgsCollapsibleGroupBox" + saveKey;
return saveKey;
}
void QgsCollapsibleGroupBox::loadState()
{
//QgsDebugMsg( "Entered" );
if ( !mSettings )
return;
if ( !isEnabled() || ( !mSaveCollapsedState && !mSaveCheckedState ) )
return;
setUpdatesEnabled( false );
QString key = saveKey();
QVariant val;
if ( mSaveCheckedState )
{
val = mSettings->value( key + "/checked" );
if ( ! val.isNull() )
setChecked( val.toBool() );
}
if ( mSaveCollapsedState )
{
val = mSettings->value( key + "/collapsed" );
if ( ! val.isNull() )
setCollapsed( val.toBool() );
}
setUpdatesEnabled( true );
}
void QgsCollapsibleGroupBox::saveState()
{
//QgsDebugMsg( "Entered" );
if ( !mSettings )
return;
if ( !isEnabled() || ( !mSaveCollapsedState && !mSaveCheckedState ) )
return;
QString key = saveKey();
if ( mSaveCheckedState )
mSettings->setValue( key + "/checked", isChecked() );
if ( mSaveCollapsedState )
mSettings->setValue( key + "/collapsed", isCollapsed() );
}