13
0
livetrax/doc/region_ops.txt
Colin Fletcher ddfc047f0e Update region_ops.txt to match current behaviour, and fix a couple of comments.
Update region_ops.txt to better describe the current behaviour of
Editor::get_regions_from_selection_and_edit_point(), and fix a couple of
comments that still referred to the no-longer-existing 'edit' property of
route groups.
2013-04-03 23:21:53 +01:00

36 lines
1.7 KiB
Plaintext

How to choose what regions to perform operations on
---------------------------------------------------
Divide region actions into 3 groups:
1. Actions that operate on the selection, and for which the edit point type and location is irrelevant.
e.g. remove-region, rename-region, boost-region-gain
2. Actions that are not related to the selection, but for which the edit point location is important
e.g. insert-region-from-region-list
3. Actions that operate on the selection, and for which the edit point location is important
e.g. set-region-sync-position, place-transient
For group 1, Editor::get_regions_from_selection_and_entered() is used to decide which regions to operate
on. This method returns the selected regions, unless there are none, in which case it returns the last
region that the mouse entered.
For group 3, Editor::get_regions_from_selection_and_edit_point() is used to decide which regions to operate
on.
If the edit point is `mouse':
if the mouse is over a selected region, or no region, this method returns all selected regions.
if the mouse is over an unselected region, just that region is returned.
For other edit points the method returns the selected regions. If no regions are selected, it returns
the regions under the edit position on the selected tracks.
The action handlers call the appropriate method to decide which regions to operate on.
In addition, Editor::sensitize_the_right_region_actions() is called when a Region menu is about to be displayed,
and it sensitizes the actions that are appropriate given the current situation. When selecting things from
a menu, group 3 operations are disabled if the edit point is `mouse', as the mouse will be positioned over
the menu and its position is hence meaningless.