JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
juce::ValueTree::SharedObject::SetPropertyAction Struct Referencefinal
Inheritance diagram for juce::ValueTree::SharedObject::SetPropertyAction:
juce::UndoableAction

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.
 
bool undo () override
 Overridden by a subclass to undo the action.
 
int getSizeInUnits () override
 Returns a value to indicate how much memory this object takes up.
 
UndoableActioncreateCoalescedAction (UndoableAction *nextAction) override
 Allows multiple actions to be coalesced into a single action object, to reduce storage space.
 
- Public Member Functions inherited from juce::UndoableAction
virtual ~UndoableAction ()=default
 Destructor.
 

Additional Inherited Members

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

Detailed Description

Definition at line 411 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 
)

Definition at line 413 of file juce_ValueTree.cpp.

Member Function Documentation

◆ createCoalescedAction()

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

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 450 of file juce_ValueTree.cpp.

◆ getSizeInUnits()

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

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 445 of file juce_ValueTree.cpp.

◆ perform()

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

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 423 of file juce_ValueTree.cpp.

◆ undo()

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

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 435 of file juce_ValueTree.cpp.


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