advancedrenamewidget.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-05-22
 * Description : a control widget for the AdvancedRename utility
 *
 * Copyright (C) 2009-2012 by Andi Clemens <andi dot clemens 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, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_ADVANCED_RENAME_WIDGET_H
#define DIGIKAM_ADVANCED_RENAME_WIDGET_H
 
// Qt includes
 
#include <QString>
#include <QWidget>
 
// Local includes
 
#include "rule.h"
#include "digikam_export.h"
 
class QMenu;
 
namespace Digikam
{
 
class ParseSettings;
class Parser;
 
class DIGIKAM_GUI_EXPORT AdvancedRenameWidget : public QWidget
{
    Q_OBJECT
 
public:
 
    enum LayoutStyle
    {
        LayoutNormal,
        LayoutCompact
    };
 
    enum ControlWidget
    {
        None               = 0x0,
        ToolTipButton      = 0x1,
        TokenButtons       = 0x2,
        ModifierToolButton = 0x4,
        DefaultControls    = TokenButtons | ToolTipButton | ModifierToolButton
    };
    Q_DECLARE_FLAGS(ControlWidgets, ControlWidget)
 
public:
 
    explicit AdvancedRenameWidget(QWidget* const parent = nullptr);
    ~AdvancedRenameWidget() override;
 
    QString parseString() const;
 
    void    setParseString(const QString& text);
 
    void setParseTimerDuration(int milliseconds);
 
    void    clearParseString();
 
    void    clear();
 
    void    setParser(Parser* parser);
 
    Parser* parser() const;
 
    QString parse(ParseSettings& settings) const;
 
    void setControlWidgets(ControlWidgets mask);
 
    void setLayoutStyle(LayoutStyle style);
 
    void focusLineEdit();
 
    void highlightLineEdit();
 
    void highlightLineEdit(const QString& word);
 
Q_SIGNALS:
 
    void signalTextChanged(const QString&);
    void signalReturnPressed();
 
private Q_SLOTS:
 
    void slotToolTipButtonToggled(bool);
    void slotTokenMarked(bool);
 
private:
 
    void createToolTip();
 
    void   registerParserControls();
    QMenu* createControlsMenu(QWidget* const parent, const RulesList& rules);
 
    void calculateLayout();
 
    void setupWidgets();
 
    void readSettings();
    void writeSettings();
 
private:
 
    // Disable
    AdvancedRenameWidget(const AdvancedRenameWidget&)            = delete;
    AdvancedRenameWidget& operator=(const AdvancedRenameWidget&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::AdvancedRenameWidget::ControlWidgets)
 
#endif // DIGIKAM_ADVANCED_RENAME_WIDGET_H