Digikam::AdvancedRenameWidget Class Reference

Inheritance diagram for Digikam::AdvancedRenameWidget:

Public Types
enum	ControlWidget {   None = 0x0 , ToolTipButton = 0x1 , TokenButtons = 0x2 , ModifierToolButton = 0x4 ,   DefaultControls = TokenButtons | ToolTipButton | ModifierToolButton }
enum	LayoutStyle { LayoutNormal , LayoutCompact }

Signals
void	signalReturnPressed ()
void	signalTextChanged (const QString &)

Public Member Functions
	AdvancedRenameWidget (QWidget *const parent=nullptr)
void	clear ()
void	clearParseString ()
void	focusLineEdit ()
void	highlightLineEdit ()
void	highlightLineEdit (const QString &word)
QString	parse (ParseSettings &settings) const
Parser *	parser () const
QString	parseString () const
void	setControlWidgets (ControlWidgets mask)
void	setLayoutStyle (LayoutStyle style)
void	setParser (Parser *parser)
void	setParseString (const QString &text)
void	setParseTimerDuration (int milliseconds)
	~AdvancedRenameWidget () override

Member Enumeration Documentation

ControlWidget

enum Digikam::AdvancedRenameWidget::ControlWidget

Enumerator
None
ToolTipButton
TokenButtons
ModifierToolButton
DefaultControls

LayoutStyle

enum Digikam::AdvancedRenameWidget::LayoutStyle

Enumerator
LayoutNormal
LayoutCompact

Constructor & Destructor Documentation

AdvancedRenameWidget()

Digikam::AdvancedRenameWidget::AdvancedRenameWidget ( QWidget *const  parent = nullptr )

explicit

~AdvancedRenameWidget()

Digikam::AdvancedRenameWidget::~AdvancedRenameWidget ( )

override

Member Function Documentation

clear()

void Digikam::AdvancedRenameWidget::clear

(

)

clears the parse string as well as the history

clearParseString()

void Digikam::AdvancedRenameWidget::clearParseString

(

)

resets the current parse string, the LineEdit widget will be empty

focusLineEdit()

void Digikam::AdvancedRenameWidget::focusLineEdit

(

)

set focus for the LineEdit widget

highlightLineEdit() [1/2]

void Digikam::AdvancedRenameWidget::highlightLineEdit

(

)

highlight the LineEdit widgets text

highlightLineEdit() [2/2]

void Digikam::AdvancedRenameWidget::highlightLineEdit

(

const QString &

word

)

highlight a word in the LineEdit widgets text

parse()

QString Digikam::AdvancedRenameWidget::parse

(

ParseSettings &

settings

)

const

evaluates the parse string and executes the parser

Parameters

settings

information about the file to be renamed

Returns

the new name of the file

References Digikam::ParseSettings::parseString.

parser()

Parser * Digikam::AdvancedRenameWidget::parser

(

)

const

returns a pointer to the currently assigned parser

Referenced by setParser().

parseString()

QString Digikam::AdvancedRenameWidget::parseString

(

)

const

returns the current parse string

setControlWidgets()

void Digikam::AdvancedRenameWidget::setControlWidgets

(

ControlWidgets

mask

)

sets the layout of the control widgets

See also

ControlWidget

Parameters

mask	a bitmask for setting the control widgets

References LayoutNormal, ModifierToolButton, TokenButtons, and ToolTipButton.

setLayoutStyle()

void Digikam::AdvancedRenameWidget::setLayoutStyle

(

LayoutStyle

style

)

set the layout style of the widget

Parameters

style

the style of the layout

See also

LayoutStyle

setParser()

void Digikam::AdvancedRenameWidget::setParser

(

Parser *

parser

)

sets the current parser. If a parser has already been assigned, it will be deleted first.

Parameters

parser

a pointer to the new parser instance

References parser().

setParseString()

void Digikam::AdvancedRenameWidget::setParseString

(

const QString &

text

)

sets the current parse string

Parameters

text	the new parse string

setParseTimerDuration()

void Digikam::AdvancedRenameWidget::setParseTimerDuration

(

int

milliseconds

)

signalReturnPressed

void Digikam::AdvancedRenameWidget::signalReturnPressed ( )

signal

signalTextChanged

void Digikam::AdvancedRenameWidget::signalTextChanged ( const QString &  )

signal

---

The documentation for this class was generated from the following files:

• core/utilities/advancedrename/advancedrenamewidget.h
• core/utilities/advancedrename/advancedrenamewidget.cpp