OpenShot Library | OpenShotAudio 0.2.2
juce::ValueTree::SharedObject::SetPropertyAction Struct Reference
+ Inheritance diagram for juce::ValueTree::SharedObject::SetPropertyAction:

Public Member Functions

 SetPropertyAction (Ptr targetObject, const Identifier &propertyName, const var &newVal, const var &oldVal, bool isAdding, bool isDeleting, ValueTree::Listener *listenerToExclude=nullptr)
 
bool perform () override
 Overridden by a subclass to perform the action. More...
 
bool undo () override
 Overridden by a subclass to undo the action. More...
 
int getSizeInUnits () override
 Returns a value to indicate how much memory this object takes up. More...
 
UndoableActioncreateCoalescedAction (UndoableAction *nextAction) override
 Allows multiple actions to be coalesced into a single action object, to reduce storage space. More...
 
- Public Member Functions inherited from juce::UndoableAction
virtual ~UndoableAction ()=default
 Destructor.
 
virtual bool perform ()=0
 Overridden by a subclass to perform the action. More...
 
virtual bool undo ()=0
 Overridden by a subclass to undo the action. More...
 
virtual int getSizeInUnits ()
 Returns a value to indicate how much memory this object takes up. More...
 
virtual UndoableActioncreateCoalescedAction (UndoableAction *nextAction)
 Allows multiple actions to be coalesced into a single action object, to reduce storage space. More...
 

Additional Inherited Members

- Protected Member Functions inherited from juce::UndoableAction
 UndoableAction ()=default
 Creates an action.
 

Detailed Description

Definition at line 412 of file juce_ValueTree.cpp.

Constructor & Destructor Documentation

◆ SetPropertyAction()

juce::ValueTree::SharedObject::SetPropertyAction::SetPropertyAction ( Ptr  targetObject,
const Identifier propertyName,
const var newVal,
const var oldVal,
bool  isAdding,
bool  isDeleting,
ValueTree::Listener listenerToExclude = nullptr 
)
inline

Definition at line 414 of file juce_ValueTree.cpp.

Member Function Documentation

◆ perform()

bool juce::ValueTree::SharedObject::SetPropertyAction::perform ( )
inlineoverridevirtual

Overridden by a subclass to perform the action.

This method is called by the UndoManager, and shouldn't be used directly by applications.

Be careful not to make any calls in a perform() method that could call recursively back into the UndoManager::perform() method

Returns
true if the action could be performed.
See also
UndoManager::perform

Implements juce::UndoableAction.

Definition at line 424 of file juce_ValueTree.cpp.

◆ undo()

bool juce::ValueTree::SharedObject::SetPropertyAction::undo ( )
inlineoverridevirtual

Overridden by a subclass to undo the action.

This method is called by the UndoManager, and shouldn't be used directly by applications.

Be careful not to make any calls in an undo() method that could call recursively back into the UndoManager::perform() method

Returns
true if the action could be undone without any errors.
See also
UndoManager::perform

Implements juce::UndoableAction.

Definition at line 436 of file juce_ValueTree.cpp.

◆ getSizeInUnits()

int juce::ValueTree::SharedObject::SetPropertyAction::getSizeInUnits ( )
inlineoverridevirtual

Returns a value to indicate how much memory this object takes up.

Because the UndoManager keeps a list of UndoableActions, this is used to work out how much space each one will take up, so that the UndoManager can work out how many to keep.

The default value returned here is 10 - units are arbitrary and don't have to be accurate.

See also
UndoManager::getNumberOfUnitsTakenUpByStoredCommands, UndoManager::setMaxNumberOfStoredUnits

Reimplemented from juce::UndoableAction.

Definition at line 446 of file juce_ValueTree.cpp.

◆ createCoalescedAction()

UndoableAction * juce::ValueTree::SharedObject::SetPropertyAction::createCoalescedAction ( UndoableAction nextAction)
inlineoverridevirtual

Allows multiple actions to be coalesced into a single action object, to reduce storage space.

If possible, this method should create and return a single action that does the same job as this one followed by the supplied action.

If it's not possible to merge the two actions, the method should return a nullptr.

Reimplemented from juce::UndoableAction.

Definition at line 451 of file juce_ValueTree.cpp.


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