Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

RelocateItemsOptions

Synopsis

struct RelocateItemsOptions {
    boolean *doNotModify;
    boolean *flat;
}

Is used to specify in which way the items should be moved by the method relocateItems (§relocateItems).

In general, the specified items are moved together with all their descendants (i.e. whole sub-trees are moved).

flat

The option flat (false by default) controls the behavior if one of the items to move is a descendant of another item to move (the ancestor). If true, the sub-tree rooted at the descendant will be moved to the father. If false, the descendant will be moved as part of the sub-tree rooted at the ancestor.

doNotModify

If option doNotModify (false by default) is true, the final step of moving the items is suppressed. Other than that, the operation behaves exactly the same way as with this option set to false, including returning the same result and throwing the same exceptions, unless they occur during the actual move of the items (which should not happen).