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 | /* ============================================================
*
* This file is a part of digiKam project
* https://www.digikam.org
*
* Date : 2009-05-22
* Description : a control widget for the AdvancedRename utility
*
* SPDX-FileCopyrightText: 2009-2012 by Andi Clemens <andi dot clemens at gmail dot com>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* ============================================================ */
#include "advancedrenamewidget.h"
// Qt includes
#include <QAction>
#include <QApplication>
#include <QGridLayout>
#include <QIcon>
#include <QMenu>
#include <QPushButton>
#include <QStyle>
#include <QToolButton>
// KDE includes
#include <kconfiggroup.h>
#include <klocalizedstring.h>
#include <ksharedconfig.h>
// Local includes
#include "digikam_globals.h"
#include "dexpanderbox.h"
#include "advancedrenameinput.h"
#include "defaultrenameparser.h"
#include "dynamiclayout.h"
#include "tooltipcreator.h"
#include "tooltipdialog.h"
namespace Digikam
{
class Q_DECL_HIDDEN AdvancedRenameWidget::Private
{
typedef AdvancedRenameWidget::ControlWidgets CWMask;
typedef AdvancedRenameWidget::LayoutStyle LStyle;
public:
Private() = default;
public:
const QString configGroupName = QLatin1String("AdvancedRename Widget");
const QString configExpandedStateEntry = QLatin1String("Options are expanded");
public:
bool configExpandedStateDefault = true;
QToolButton* tooltipToggleButton = nullptr;
QToolButton* modifiersToolButton = nullptr;
QPushButton* optionsButton = nullptr;
QPushButton* modifiersButton = nullptr;
QWidget* btnContainer = nullptr;
TooltipDialog* tooltipDialog = nullptr;
AdvancedRenameInput* renameInput = nullptr;
Parser* parser = nullptr;
DLabelExpander* optionsLabel = nullptr;
CWMask controlWidgetsMask = AdvancedRenameWidget::DefaultControls;
LStyle layoutStyle = AdvancedRenameWidget::LayoutNormal;
};
// --------------------------------------------------------
AdvancedRenameWidget::AdvancedRenameWidget(QWidget* const parent)
: QWidget(parent),
d (new Private)
{
setupWidgets();
}
AdvancedRenameWidget::~AdvancedRenameWidget()
{
writeSettings();
delete d;
}
QString AdvancedRenameWidget::parseString() const
{
return d->renameInput->text();
}
void AdvancedRenameWidget::setParseString(const QString& text)
{
d->renameInput->setText(text);
}
void AdvancedRenameWidget::setParseTimerDuration(int milliseconds)
{
d->renameInput->setParseTimerDuration(milliseconds);
}
void AdvancedRenameWidget::clearParseString()
{
d->renameInput->slotClearText();
}
void AdvancedRenameWidget::clear()
{
d->renameInput->slotClearTextAndHistory();
}
QString AdvancedRenameWidget::parse(ParseSettings& settings) const
{
if (!d->parser)
{
return QString();
}
settings.parseString = d->renameInput->text();
QString parsed;
parsed = d->parser->parse(settings);
return parsed;
}
void AdvancedRenameWidget::createToolTip()
{
d->tooltipDialog->clearTooltip();
if (d->parser)
{
d->tooltipDialog->setTooltip(TooltipCreator::getInstance().tooltip(d->parser));
}
}
void AdvancedRenameWidget::slotToolTipButtonToggled(bool checked)
{
Q_UNUSED(checked)
if (!d->tooltipDialog->isVisible())
{
d->tooltipDialog->show();
}
d->tooltipDialog->raise();
}
void AdvancedRenameWidget::setLayoutStyle(LayoutStyle style)
{
d->layoutStyle = style;
calculateLayout();
}
void AdvancedRenameWidget::setControlWidgets(ControlWidgets mask)
{
d->controlWidgetsMask = mask;
// we need a parser and at least one renaming option to successfully use
// this widget.
bool enable = d->parser && !(d->parser->options().isEmpty());
// enable the modifier toolbutton if environment has been set up correctly
bool enableModBtn = enable && !(d->parser->modifiers().isEmpty());
d->renameInput->setEnabled(enable);
d->tooltipToggleButton->setVisible(enable && (mask & ToolTipButton));
// layout specific
if (d->layoutStyle == LayoutNormal)
{
d->optionsLabel->setVisible(enable && (mask & TokenButtons));
d->modifiersToolButton->setVisible(enableModBtn && (mask & ModifierToolButton));
}
else
{
d->optionsButton->setVisible(enableModBtn && (mask & TokenButtons));
d->modifiersButton->setVisible(enableModBtn && (mask & ModifierToolButton));
}
}
QMenu* AdvancedRenameWidget::createControlsMenu(QWidget* const parent, const RulesList& rules)
{
QMenu* const menu = new QMenu(parent);
QAction* action = nullptr;<--- Variable 'action' can be declared as pointer to const
for (Rule* const rule : std::as_const(rules))
{
action = rule->registerMenu(menu);
if (!action)
{
continue;
}
connect(rule, SIGNAL(signalTokenTriggered(QString)),
d->renameInput, SLOT(slotAddToken(QString)));
}
return menu;
}
void AdvancedRenameWidget::registerParserControls()
{
if (d->parser)
{
setupWidgets();
RulesList optionsList = d->parser->options();
RulesList modifiersList = d->parser->modifiers();
if (d->layoutStyle == LayoutNormal)
{
// register options
QPushButton* btn = nullptr;
const int cmargin = qMin(style()->pixelMetric(QStyle::PM_LayoutLeftMargin),
qMin(style()->pixelMetric(QStyle::PM_LayoutTopMargin),
qMin(style()->pixelMetric(QStyle::PM_LayoutRightMargin),
style()->pixelMetric(QStyle::PM_LayoutBottomMargin))));
DynamicLayout* const layout = new DynamicLayout(cmargin, cmargin);
const auto list = d->parser->options();
for (Rule* const p : list)
{
btn = p->registerButton(this);
if (!btn)
{
continue;
}
// set button tooltip
btn->setToolTip(p->description());
layout->addWidget(btn);
connect(p, SIGNAL(signalTokenTriggered(QString)),
d->renameInput, SLOT(slotAddToken(QString)));
}
d->btnContainer->setLayout(layout);
setMinimumWidth(d->btnContainer->layout()->sizeHint().width());
// register modifiers
QMenu* const modifiersMenu = createControlsMenu(d->modifiersToolButton, modifiersList);
d->modifiersToolButton->setMenu(modifiersMenu);
}
else // LayoutCompact
{
// register options
QMenu* const optionsMenu = createControlsMenu(d->optionsButton, optionsList);
d->optionsButton->setMenu(optionsMenu);
// register modifiers
QMenu* const modifiersMenu = createControlsMenu(d->modifiersButton, modifiersList);
d->modifiersButton->setMenu(modifiersMenu);
}
// --------------------------------------------------------
d->renameInput->setParser(d->parser);
createToolTip();
}
}
Parser* AdvancedRenameWidget::parser() const
{
return d->parser;
}
void AdvancedRenameWidget::setParser(Parser* parser)
{
if (!parser)
{
return;
}
d->parser = parser;
calculateLayout();
}
void AdvancedRenameWidget::calculateLayout()
{
registerParserControls();
setControlWidgets(d->controlWidgetsMask);
}
void AdvancedRenameWidget::setupWidgets()
{
/*
* This methods needs to delete all main widgets, do not remove the delete lines!
* If a new parser is set or the layout has changed, we need to call setupWidgets() again.
* So any widget that is created in here needs to be removed first, to avoid memory leaks and
* duplicate signal/slot connections.
*/
delete d->tooltipDialog;
delete d->renameInput;
delete d->tooltipToggleButton;
delete d->optionsButton;
delete d->modifiersButton;
delete d->btnContainer;
delete d->optionsLabel;
delete d->modifiersToolButton;
// --------------------------------------------------------
d->tooltipDialog = new TooltipDialog(this);
d->tooltipDialog->resize(650, 530);
d->renameInput = new AdvancedRenameInput;
d->renameInput->setToolTip(i18n("<p>Enter your renaming pattern here. Use the access buttons to quickly add renaming "
"options and modifiers. For further explanation, use the information button.</p>"));
// --------------------------------------------------------
d->tooltipToggleButton = new QToolButton;
d->tooltipToggleButton->setIcon(QIcon::fromTheme(QLatin1String("dialog-information")));
d->tooltipToggleButton->setToolTip(i18n("Show a list of all available options"));
// --------------------------------------------------------
QString modifiersStr = i18n("Modifiers");
QIcon modifiersIcon = QIcon::fromTheme(QLatin1String("document-edit"));
QString modifiersTooltip = i18n("<p>Add a modifier to a renaming option. "
"To activate this button, place the cursor behind a renaming option "
"or an already assigned modifier.</p>");
// --------------------------------------------------------
delete layout();
QGridLayout* const mainLayout = new QGridLayout;
if (d->layoutStyle == LayoutNormal)
{
d->btnContainer = new QWidget(this);
d->optionsLabel = new DLabelExpander(this);
d->optionsLabel->setText(i18n("Renaming Options"));
d->optionsLabel->setWidget(d->btnContainer);
d->optionsLabel->setLineVisible(false);
d->modifiersToolButton = new QToolButton;
d->modifiersToolButton->setPopupMode(QToolButton::InstantPopup);
d->modifiersToolButton->setText(modifiersStr);
d->modifiersToolButton->setIcon(modifiersIcon);
d->modifiersToolButton->setToolTip(modifiersTooltip);
mainLayout->addWidget(d->renameInput, 0, 0, 1, 1);
mainLayout->addWidget(d->modifiersToolButton, 0, 1, 1, 1);
mainLayout->addWidget(d->tooltipToggleButton, 0, 2, 1, 1);
mainLayout->addWidget(d->optionsLabel, 1, 0, 1, -1);
mainLayout->setColumnStretch(0, 10);
}
else
{
d->optionsButton = new QPushButton;
d->optionsButton->setText(i18n("Options"));
d->optionsButton->setIcon(QIcon::fromTheme(QLatin1String("configure")));
d->optionsButton->setToolTip(i18n("<p>Add renaming options to the parse string.</p>"));
// --------------------------------------------------------
d->modifiersButton = new QPushButton;
d->modifiersButton->setText(modifiersStr);
d->modifiersButton->setIcon(modifiersIcon);
d->modifiersButton->setToolTip(modifiersTooltip);
mainLayout->addWidget(d->renameInput, 0, 0, 1, -1);
mainLayout->addWidget(d->optionsButton, 1, 0, 1, 1);
mainLayout->addWidget(d->modifiersButton, 1, 1, 1, 1);
mainLayout->addWidget(d->tooltipToggleButton, 1, 3, 1, 1);
mainLayout->setColumnStretch(2, 10);
}
const int cmargin = layoutMargin();
mainLayout->setSpacing(cmargin);
mainLayout->setContentsMargins(QMargins(cmargin, cmargin, cmargin, cmargin));
setLayout(mainLayout);
// --------------------------------------------------------
connect(d->tooltipToggleButton, SIGNAL(clicked(bool)),
this, SLOT(slotToolTipButtonToggled(bool)));
connect(d->renameInput, SIGNAL(signalTextChanged(QString)),
this, SIGNAL(signalTextChanged(QString)));
connect(d->renameInput, SIGNAL(signalTokenMarked(bool)),
this, SLOT(slotTokenMarked(bool)));
connect(d->renameInput, SIGNAL(signalReturnPressed()),
this, SIGNAL(signalReturnPressed()));
slotTokenMarked(false);
readSettings();
}
void AdvancedRenameWidget::slotTokenMarked(bool marked)
{
bool enable = (marked && d->parser);
bool enableMod = (enable && !(d->parser->modifiers().isEmpty()));
if (d->layoutStyle == LayoutNormal)
{
d->modifiersToolButton->setEnabled(enableMod);
}
else
{
d->modifiersButton->setEnabled(enableMod);
}
}
void AdvancedRenameWidget::focusLineEdit()
{
d->renameInput->slotSetFocus();
}
void AdvancedRenameWidget::highlightLineEdit()
{
d->renameInput->slotHighlightLineEdit();
}
void AdvancedRenameWidget::highlightLineEdit(const QString& word)
{
d->renameInput->slotHighlightLineEdit(word);
}
void AdvancedRenameWidget::readSettings()
{
KSharedConfig::Ptr config = KSharedConfig::openConfig();
KConfigGroup group = config->group(d->configGroupName);
if (d->layoutStyle == LayoutNormal)
{
d->optionsLabel->setExpanded(group.readEntry(d->configExpandedStateEntry, d->configExpandedStateDefault));
}
}
void AdvancedRenameWidget::writeSettings()
{
KSharedConfig::Ptr config = KSharedConfig::openConfig();
KConfigGroup group = config->group(d->configGroupName);
if (d->layoutStyle == LayoutNormal)
{
group.writeEntry(d->configExpandedStateEntry, d->optionsLabel ? d->optionsLabel->isExpanded()
: d->configExpandedStateDefault);
}
}
} // namespace Digikam
#include "moc_advancedrenamewidget.cpp"
|