-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsoptionsdialogbase.cpp
486 lines (421 loc) · 15.3 KB
/
qgsoptionsdialogbase.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
/***************************************************************************
qgsoptionsdialogbase.cpp - base vertical tabs option dialog
---------------------
begin : March 24, 2013
copyright : (C) 2013 by Larry Shaffer
email : larrys at dakcarto 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 "qgsoptionsdialogbase.h"
#include <QCheckBox>
#include <QDialog>
#include <QDialogButtonBox>
#include <QEvent>
#include <QGroupBox>
#include <QLabel>
#include <QLayout>
#include <QListWidget>
#include <QListWidgetItem>
#include <QMessageBox>
#include <QPainter>
#include <QScrollBar>
#include <QSplitter>
#include <QStackedWidget>
#include <QTimer>
#include <QTreeView>
#include <QAbstractItemModel>
#include "qgsfilterlineedit.h"
#include "qgslogger.h"
QgsOptionsDialogBase::QgsOptionsDialogBase( const QString &settingsKey, QWidget *parent, Qt::WindowFlags fl, QgsSettings *settings )
: QDialog( parent, fl )
, mOptsKey( settingsKey )
, mInit( false )
, mIconOnly( false )
, mSettings( settings )
, mDelSettings( false )
{
}
QgsOptionsDialogBase::~QgsOptionsDialogBase()
{
if ( mInit )
{
mSettings->setValue( QStringLiteral( "/Windows/%1/geometry" ).arg( mOptsKey ), saveGeometry() );
mSettings->setValue( QStringLiteral( "/Windows/%1/splitState" ).arg( mOptsKey ), mOptSplitter->saveState() );
mSettings->setValue( QStringLiteral( "/Windows/%1/tab" ).arg( mOptsKey ), mOptStackedWidget->currentIndex() );
}
if ( mDelSettings ) // local settings obj to delete
{
delete mSettings;
}
mSettings = nullptr; // null the pointer (in case of outside settings obj)
}
void QgsOptionsDialogBase::initOptionsBase( bool restoreUi, const QString &title )
{
// use pointer to app QgsSettings if no custom QgsSettings specified
// custom QgsSettings object may be from Python plugin
mDelSettings = false;
if ( !mSettings )
{
mSettings = new QgsSettings();
mDelSettings = true; // only delete obj created by class
}
// save dialog title so it can be used to be concatenated
// with category title in icon-only mode
if ( title.isEmpty() )
mDialogTitle = windowTitle();
else
mDialogTitle = title;
// don't add to dialog margins
// redefine now, or those in inherited .ui file will be added
if ( layout() )
{
layout()->setContentsMargins( 0, 0, 0, 0 ); // Qt default spacing
}
// start with copy of qgsoptionsdialog_template.ui to ensure existence of these objects
mOptListWidget = findChild<QListWidget *>( QStringLiteral( "mOptionsListWidget" ) );
QFrame *optionsFrame = findChild<QFrame *>( QStringLiteral( "mOptionsFrame" ) );
mOptStackedWidget = findChild<QStackedWidget *>( QStringLiteral( "mOptionsStackedWidget" ) );
mOptSplitter = findChild<QSplitter *>( QStringLiteral( "mOptionsSplitter" ) );
mOptButtonBox = findChild<QDialogButtonBox *>( QStringLiteral( "buttonBox" ) );
QFrame *buttonBoxFrame = findChild<QFrame *>( QStringLiteral( "mButtonBoxFrame" ) );
mSearchLineEdit = findChild<QgsFilterLineEdit *>( QStringLiteral( "mSearchLineEdit" ) );
if ( !mOptListWidget || !mOptStackedWidget || !mOptSplitter || !optionsFrame )
{
return;
}
int size = mSettings->value( QStringLiteral( "/IconSize" ), 24 ).toInt();
// buffer size to match displayed icon size in toolbars, and expected geometry restore
// newWidth (above) may need adjusted if you adjust iconBuffer here
int iconBuffer = 4;
mOptListWidget->setIconSize( QSize( size + iconBuffer, size + iconBuffer ) );
mOptListWidget->setFrameStyle( QFrame::NoFrame );
optionsFrame->layout()->setContentsMargins( 0, 3, 3, 3 );
QVBoxLayout *layout = static_cast<QVBoxLayout *>( optionsFrame->layout() );
if ( buttonBoxFrame )
{
buttonBoxFrame->layout()->setContentsMargins( 0, 0, 0, 0 );
layout->insertWidget( layout->count() + 1, buttonBoxFrame );
}
else if ( mOptButtonBox )
{
layout->insertWidget( layout->count() + 1, mOptButtonBox );
}
if ( mOptButtonBox )
{
// enforce only one connection per signal, in case added in Qt Designer
disconnect( mOptButtonBox, &QDialogButtonBox::accepted, this, &QDialog::accept );
connect( mOptButtonBox, &QDialogButtonBox::accepted, this, &QDialog::accept );
disconnect( mOptButtonBox, &QDialogButtonBox::rejected, this, &QDialog::reject );
connect( mOptButtonBox, &QDialogButtonBox::rejected, this, &QDialog::reject );
}
connect( mOptSplitter, &QSplitter::splitterMoved, this, &QgsOptionsDialogBase::updateOptionsListVerticalTabs );
connect( mOptStackedWidget, &QStackedWidget::currentChanged, this, &QgsOptionsDialogBase::optionsStackedWidget_CurrentChanged );
connect( mOptStackedWidget, &QStackedWidget::widgetRemoved, this, &QgsOptionsDialogBase::optionsStackedWidget_WidgetRemoved );
if ( mSearchLineEdit )
{
mSearchLineEdit->setShowSearchIcon( true );
connect( mSearchLineEdit, &QgsFilterLineEdit::textChanged, this, &QgsOptionsDialogBase::searchText );
}
mInit = true;
if ( restoreUi )
restoreOptionsBaseUi( mDialogTitle );
}
void QgsOptionsDialogBase::setSettings( QgsSettings *settings )
{
if ( mDelSettings ) // local settings obj to delete
{
delete mSettings;
}
mSettings = settings;
mDelSettings = false; // don't delete outside obj
}
void QgsOptionsDialogBase::restoreOptionsBaseUi( const QString &title )
{
if ( !mInit )
{
return;
}
if ( !title.isEmpty() )
{
mDialogTitle = title;
updateWindowTitle();
}
// re-save original dialog title in case it was changed after dialog initialization
mDialogTitle = windowTitle();
restoreGeometry( mSettings->value( QStringLiteral( "/Windows/%1/geometry" ).arg( mOptsKey ) ).toByteArray() );
// mOptListWidget width is fixed to take up less space in QtDesigner
// revert it now unless the splitter's state hasn't been saved yet
mOptListWidget->setMaximumWidth(
mSettings->value( QStringLiteral( "/Windows/%1/splitState" ).arg( mOptsKey ) ).isNull() ? 150 : 16777215 );
mOptSplitter->restoreState( mSettings->value( QStringLiteral( "/Windows/%1/splitState" ).arg( mOptsKey ) ).toByteArray() );
int curIndx = mSettings->value( QStringLiteral( "/Windows/%1/tab" ).arg( mOptsKey ), 0 ).toInt();
// if the last used tab is out of range or not enabled display the first enabled one
if ( mOptStackedWidget->count() < ( curIndx + 1 )
|| !mOptStackedWidget->widget( curIndx )->isEnabled() )
{
curIndx = 0;
for ( int i = 0; i < mOptStackedWidget->count(); i++ )
{
if ( mOptStackedWidget->widget( i )->isEnabled() )
{
curIndx = i;
break;
}
}
}
if ( mOptStackedWidget->count() != 0 && mOptListWidget->count() != 0 )
{
mOptStackedWidget->setCurrentIndex( curIndx );
mOptListWidget->setCurrentRow( curIndx );
}
// get rid of annoying outer focus rect on Mac
mOptListWidget->setAttribute( Qt::WA_MacShowFocusRect, false );
}
void QgsOptionsDialogBase::searchText( const QString &text )
{
mSearchLineEdit->setMinimumWidth( text.isEmpty() ? 0 : 70 );
if ( !mOptStackedWidget )
return;
if ( mOptStackedWidget->isHidden() )
mOptStackedWidget->show();
if ( mOptButtonBox && mOptButtonBox->isHidden() )
mOptButtonBox->show();
// hide all page if text has to be search, show them all otherwise
for ( int r = 0; r < mOptListWidget->count(); ++r )
{
mOptListWidget->setRowHidden( r, !text.isEmpty() );
}
for ( const QPair< QgsSearchHighlightOptionWidget *, int > &rsw : qgsAsConst( mRegisteredSearchWidgets ) )
{
rsw.first->reset();
if ( !text.isEmpty() && rsw.first->searchHighlight( text ) )
{
QgsDebugMsgLevel( QString( "Found %1 in %2 (tab: %3)" )
.arg( text )
.arg( rsw.first->isValid() ? rsw.first->widget()->objectName() : "no widget" )
.arg( mOptListWidget->item( rsw.second )->text() ), 4 );
mOptListWidget->setRowHidden( rsw.second, false );
}
}
if ( mOptListWidget->isRowHidden( mOptStackedWidget->currentIndex() ) )
{
for ( int r = 0; r < mOptListWidget->count(); ++r )
{
if ( !mOptListWidget->isRowHidden( r ) )
{
mOptListWidget->setCurrentRow( r );
return;
}
}
// if no page can be shown, hide stack widget
mOptStackedWidget->hide();
if ( mOptButtonBox )
mOptButtonBox->hide();
}
}
void QgsOptionsDialogBase::registerTextSearchWidgets()
{
mRegisteredSearchWidgets.clear();
for ( int i = 0; i < mOptStackedWidget->count(); i++ )
{
Q_FOREACH ( QWidget *w, mOptStackedWidget->widget( i )->findChildren<QWidget *>() )
{
QgsSearchHighlightOptionWidget *shw = new QgsSearchHighlightOptionWidget( w );
if ( shw->isValid() )
{
QgsDebugMsgLevel( QString( "Registering: %1" ).arg( w->objectName() ), 4 );
mRegisteredSearchWidgets.append( qMakePair( shw, i ) );
}
else
{
delete shw;
}
}
}
}
void QgsOptionsDialogBase::showEvent( QShowEvent *e )
{
if ( mInit )
{
updateOptionsListVerticalTabs();
optionsStackedWidget_CurrentChanged( mOptListWidget->currentRow() );
}
else
{
QTimer::singleShot( 0, this, SLOT( warnAboutMissingObjects() ) );
}
if ( mSearchLineEdit )
{
registerTextSearchWidgets();
}
QDialog::showEvent( e );
}
void QgsOptionsDialogBase::paintEvent( QPaintEvent *e )
{
if ( mInit )
QTimer::singleShot( 0, this, SLOT( updateOptionsListVerticalTabs() ) );
QDialog::paintEvent( e );
}
void QgsOptionsDialogBase::updateWindowTitle()
{
QListWidgetItem *curitem = mOptListWidget->currentItem();
if ( curitem )
{
setWindowTitle( QStringLiteral( "%1 | %2" ).arg( mDialogTitle, curitem->text() ) );
}
else
{
setWindowTitle( mDialogTitle );
}
}
void QgsOptionsDialogBase::updateOptionsListVerticalTabs()
{
if ( !mInit )
return;
if ( mOptListWidget->maximumWidth() != 16777215 )
mOptListWidget->setMaximumWidth( 16777215 );
// auto-resize splitter for vert scrollbar without covering icons in icon-only mode
// TODO: mOptListWidget has fixed 32px wide icons for now, allow user-defined
// Note: called on splitter resize and dialog paint event, so only update when necessary
int iconWidth = mOptListWidget->iconSize().width();
int snapToIconWidth = iconWidth + 32;
QList<int> splitSizes = mOptSplitter->sizes();
mIconOnly = ( splitSizes.at( 0 ) <= snapToIconWidth );
// iconBuffer (above) may need adjusted if you adjust iconWidth here
int newWidth = mOptListWidget->verticalScrollBar()->isVisible() ? iconWidth + 22 : iconWidth + 9;
bool diffWidth = mOptListWidget->minimumWidth() != newWidth;
if ( diffWidth )
mOptListWidget->setMinimumWidth( newWidth );
if ( mIconOnly && ( diffWidth || mOptListWidget->width() != newWidth ) )
{
splitSizes[1] = splitSizes.at( 1 ) - ( splitSizes.at( 0 ) - newWidth );
splitSizes[0] = newWidth;
mOptSplitter->setSizes( splitSizes );
}
if ( mOptListWidget->wordWrap() && mIconOnly )
mOptListWidget->setWordWrap( false );
if ( !mOptListWidget->wordWrap() && !mIconOnly )
mOptListWidget->setWordWrap( true );
}
void QgsOptionsDialogBase::optionsStackedWidget_CurrentChanged( int indx )
{
mOptListWidget->blockSignals( true );
mOptListWidget->setCurrentRow( indx );
mOptListWidget->blockSignals( false );
updateWindowTitle();
}
void QgsOptionsDialogBase::optionsStackedWidget_WidgetRemoved( int indx )
{
// will need to take item first, if widgets are set for item in future
delete mOptListWidget->item( indx );
QList<QPair< QgsSearchHighlightOptionWidget *, int > >::iterator it = mRegisteredSearchWidgets.begin();
while ( it != mRegisteredSearchWidgets.end() )
{
if ( ( *it ).second == indx )
it = mRegisteredSearchWidgets.erase( it );
else
++it;
}
}
void QgsOptionsDialogBase::warnAboutMissingObjects()
{
QMessageBox::warning( nullptr, tr( "Missing objects" ),
tr( "Base options dialog could not be initialized.\n\n"
"Missing some of the .ui template objects:\n" )
+ " mOptionsListWidget,\n mOptionsStackedWidget,\n mOptionsSplitter,\n mOptionsListFrame",
QMessageBox::Ok,
QMessageBox::Ok );
}
QgsSearchHighlightOptionWidget::QgsSearchHighlightOptionWidget( QWidget *widget )
: QObject( widget )
, mWidget( widget )
, mText( [ = ]() {return QString();} )
{
if ( qobject_cast<QLabel *>( widget ) )
{
mStyleSheet = QStringLiteral( "QLabel { background-color: yellow; color: blue;}" );
mText = [ = ]() {return qobject_cast<QLabel *>( mWidget )->text();};
}
else if ( qobject_cast<QCheckBox *>( widget ) )
{
mStyleSheet = QStringLiteral( "QCheckBox { background-color: yellow; color: blue;}" );
mText = [ = ]() {return qobject_cast<QCheckBox *>( mWidget )->text();};
}
else if ( qobject_cast<QAbstractButton *>( widget ) )
{
mStyleSheet = QStringLiteral( "QAbstractButton { background-color: yellow; color: blue;}" );
mText = [ = ]() {return qobject_cast<QAbstractButton *>( mWidget )->text();};
}
else if ( qobject_cast<QGroupBox *>( widget ) )
{
mStyleSheet = QStringLiteral( "QGroupBox::title { background-color: yellow; color: blue;}" );
mText = [ = ]() {return qobject_cast<QGroupBox *>( mWidget )->title();};
}
else if ( qobject_cast<QTreeView *>( widget ) )
{
// TODO - style individual matching items
}
else
{
mValid = false;
}
if ( mValid )
{
mStyleSheet.prepend( "/*!search!*/" ).append( "/*!search!*/" );
QgsDebugMsgLevel( mStyleSheet, 4 );
connect( mWidget, &QWidget::destroyed, this, &QgsSearchHighlightOptionWidget::widgetDestroyed );
}
}
bool QgsSearchHighlightOptionWidget::searchHighlight( const QString &searchText )
{
bool found = false;
if ( !mWidget )
return found;
if ( !searchText.isEmpty() )
{
if ( QTreeView *tree = qobject_cast<QTreeView *>( mWidget ) )
{
QModelIndexList hits = tree->model()->match( tree->model()->index( 0, 0 ), Qt::DisplayRole, searchText, 1, Qt::MatchContains | Qt::MatchRecursive );
found = !hits.isEmpty();
}
else
{
QString origText = mText();
if ( origText.contains( searchText, Qt::CaseInsensitive ) )
{
found = true;
}
}
}
if ( found && !mChangedStyle )
{
if ( !mWidget->isVisible() )
{
// show the widget to get initial stylesheet in case it's modified
mWidget->show();
}
mWidget->setStyleSheet( mWidget->styleSheet() + mStyleSheet );
mChangedStyle = true;
}
return found;
}
void QgsSearchHighlightOptionWidget::reset()
{
if ( mValid && mChangedStyle )
{
QString ss = mWidget->styleSheet();
ss.remove( mStyleSheet );
mWidget->setStyleSheet( ss );
mChangedStyle = false;
}
}
void QgsSearchHighlightOptionWidget::widgetDestroyed()
{
mValid = false;
}