Krita Source Code Documentation
Loading...
Searching...
No Matches
DisableUIUpdatesCommand Class Reference
+ Inheritance diagram for DisableUIUpdatesCommand:

Public Member Functions

bool canMergeWith (const KUndo2Command *command) const override
 
 DisableUIUpdatesCommand (KisImageWSP image, bool finalUpdate)
 
int id () const override
 
bool mergeWith (const KUndo2Command *command) override
 
void partA () override
 
void partB () override
 
- Public Member Functions inherited from KisCommandUtils::FlipFlopCommand
 FlipFlopCommand (bool finalizing=false, KUndo2Command *parent=0)
 
 FlipFlopCommand (State initialState, KUndo2Command *parent=0)
 
void redo () override
 
void undo () override
 
- Public Member Functions inherited from KUndo2Command
QString actionText () const
 
virtual bool canAnnihilateWith (const KUndo2Command *other) const
 
const KUndo2Commandchild (int index) const
 
int childCount () const
 
virtual QTime endTime () const
 
KUndo2CommandExtraDataextraData () const
 
bool hasParent () const
 
virtual bool isMerged () const
 
 KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)
 
 KUndo2Command (KUndo2Command *parent=0)
 
virtual QVector< KUndo2Command * > mergeCommandsVector () const
 
virtual void redoMergedCommands ()
 
void setEndTime ()
 
virtual void setEndTime (const QTime &time)
 
void setExtraData (KUndo2CommandExtraData *data)
 
void setText (const KUndo2MagicString &text)
 
void setTime ()
 
virtual void setTime (const QTime &time)
 
virtual void setTimedID (int timedID)
 
KUndo2MagicString text () const
 
virtual QTime time () const
 
virtual int timedId () const
 
virtual bool timedMergeWith (KUndo2Command *other)
 
virtual void undoMergedCommands ()
 
virtual ~KUndo2Command ()
 
- Public Member Functions inherited from KisAsynchronouslyMergeableCommandInterface
virtual ~KisAsynchronouslyMergeableCommandInterface ()
 

Private Attributes

KisImageWSP m_image
 

Additional Inherited Members

- Public Types inherited from KisCommandUtils::FlipFlopCommand
enum  State { INITIALIZING , FINALIZING }
 
- Protected Member Functions inherited from KisCommandUtils::FlipFlopCommand
State getState () const
 
bool isFirstRedo () const
 

Detailed Description

Definition at line 25 of file kis_processing_applicator.cpp.

Constructor & Destructor Documentation

◆ DisableUIUpdatesCommand()

DisableUIUpdatesCommand::DisableUIUpdatesCommand ( KisImageWSP image,
bool finalUpdate )
inline

Definition at line 28 of file kis_processing_applicator.cpp.

30 : FlipFlopCommand(finalUpdate),
31 m_image(image)
32 {
33 }
FlipFlopCommand(State initialState, KUndo2Command *parent=0)

Member Function Documentation

◆ canMergeWith()

bool DisableUIUpdatesCommand::canMergeWith ( const KUndo2Command * command) const
inlineoverridevirtual
Returns
true if command can be merged with (*this) command using KUndo2Command::mergeWith() call.

WARNING: if canMergeWith() returned true, then mergeWith() must also return true. Otherwise KisSavedMacroCommand will be able to enter inconsistent state and assert.

Implements KisAsynchronouslyMergeableCommandInterface.

Definition at line 51 of file kis_processing_applicator.cpp.

51 {
52 const DisableUIUpdatesCommand *other =
53 dynamic_cast<const DisableUIUpdatesCommand*>(command);
54
55 return other && other->m_image == m_image;
56 }

References m_image.

◆ id()

int DisableUIUpdatesCommand::id ( ) const
inlineoverridevirtual

Returns the ID of this command.

A command ID is used in command compression. It must be an integer unique to this command's class, or -1 if the command doesn't support compression.

If the command supports compression this function must be overridden in the derived class to return the correct ID. The base implementation returns -1.

KUndo2QStack::push() will only try to merge two commands if they have the same ID, and the ID is not -1.

See also
mergeWith(), KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 43 of file kis_processing_applicator.cpp.

References KisCommandUtils::DisableUIUpdatesCommandId.

◆ mergeWith()

bool DisableUIUpdatesCommand::mergeWith ( const KUndo2Command * command)
inlineoverridevirtual

Attempts to merge this command with command. Returns true on success; otherwise returns false.

If this function returns true, calling this command's redo() must have the same effect as redoing both this command and command. Similarly, calling this command's undo() must have the same effect as undoing command and this command.

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also
id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 47 of file kis_processing_applicator.cpp.

47 {
48 return canMergeWith(command);
49 }
bool canMergeWith(const KUndo2Command *command) const override

References canMergeWith().

◆ partA()

void DisableUIUpdatesCommand::partA ( )
inlineoverridevirtual

Reimplemented from KisCommandUtils::FlipFlopCommand.

Definition at line 35 of file kis_processing_applicator.cpp.

35 {
37 }
void disableUIUpdates() override

References KisImage::disableUIUpdates(), and m_image.

◆ partB()

void DisableUIUpdatesCommand::partB ( )
inlineoverridevirtual

Reimplemented from KisCommandUtils::FlipFlopCommand.

Definition at line 39 of file kis_processing_applicator.cpp.

39 {
41 }
QVector< QRect > enableUIUpdates() override

References KisImage::enableUIUpdates(), and m_image.

Member Data Documentation

◆ m_image

KisImageWSP DisableUIUpdatesCommand::m_image
private

Definition at line 59 of file kis_processing_applicator.cpp.


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