From b5ab2e030b3c8de6c7f41c8d533de2462437ce7c Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Wed, 3 Nov 2010 22:19:29 +0000 Subject: Tidy up the region menu a bit, and hopefully clarify what regions will be operated on in different circumstances. Make the main menubar Region menu the same as the context one, and use the same logic to sensitize/desensitize actions for them. git-svn-id: svn://localhost/ardour2/branches/3.0@7954 d708f5d6-7413-0410-9779-e7cbd77b26cf --- doc/region_ops.txt | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 doc/region_ops.txt (limited to 'doc') diff --git a/doc/region_ops.txt b/doc/region_ops.txt new file mode 100644 index 0000000000..69851bf3eb --- /dev/null +++ b/doc/region_ops.txt @@ -0,0 +1,36 @@ +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 AND those that are both under the edit position +AND on a selected track, or on a track which is in the same active edit-enabled route group as a selected +region. + +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. -- cgit v1.2.3