Section FreeObjects

FreeObject utility functions.

See
FreeObject

Summary

Return typeFunction and summary
intCopyFreeObjects(Score src, Score dest)
Copy free objects from one Score to another.
intDeleteAllFreeObjects(Score score)
Delete all free objects from a score, without confirmation.
intDeleteHiddenFreeObjects(Score score)
Delete all hidden free objects from a score, without confirmation.
 DeleteReservedPages(Score score)
Delete reserved pages from a score, if any, and move or delete the free objects visible on the reserved pages.
 InsertReservedPages(Score score)
Insert reserved pages, after the already existing if any) and shift the free objects to next pages.

Functions

CopyFreeObjects(Score src, Score dest)

Copy free objects from one Score to another.

FreeObject visible only on a specific view are copied to the view with the same name, else to all views.
All properties, including tags, are copied.

ParameterTypeDefaultDescription
srcScore src
destScore dest
Return
int: Number of copied free objects

InsertReservedPages(Score score)

Insert reserved pages, after the already existing if any) and shift the free objects to next pages.

e.g.: A free object is on page 2 of a score without any reserved pages, after insertion of 1 reserved page, the free object will move to page 3.

ParameterTypeDefaultDescription
scoreScore score

DeleteReservedPages(Score score)

Delete reserved pages from a score, if any, and move or delete the free objects visible on the reserved pages.

  • A free object is on the 2nd page of the score, but page 3 as the score has 1 reserved page: the object will move to page 2 to stay on 2nd score page.
  • Free objects visible only on reserved pages are deleted.

ParameterTypeDefaultDescription
scoreScore score

DeleteAllFreeObjects(Score score)

Delete all free objects from a score, without confirmation.

ParameterTypeDefaultDescription
scoreScore score
Return
int: Number of deleted free objects

DeleteHiddenFreeObjects(Score score)

Delete all hidden free objects from a score, without confirmation.

A free object is hidden when "Don't print" is checked."

ParameterTypeDefaultDescription
scoreScore score
Return
int: Number of deleted free objects