xref: /haiku/src/kits/tracker/SlowMenu.h (revision 7749d0bb0c358a3279b1b9cc76d8376e900130a5)
1 /*
2 Open Tracker License
3 
4 Terms and Conditions
5 
6 Copyright (c) 1991-2000, Be Incorporated. All rights reserved.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a copy of
9 this software and associated documentation files (the "Software"), to deal in
10 the Software without restriction, including without limitation the rights to
11 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 of the Software, and to permit persons to whom the Software is furnished to do
13 so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice applies to all licensees
16 and shall be included in all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF TITLE, MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 BE INCORPORATED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 
25 Except as contained in this notice, the name of Be Incorporated shall not be
26 used in advertising or otherwise to promote the sale, use or other dealings in
27 this Software without prior written authorization from Be Incorporated.
28 
29 Tracker(TM), Be(R), BeOS(R), and BeIA(TM) are trademarks or registered trademarks
30 of Be Incorporated in the United States and other countries. Other brand product
31 names are registered trademarks or trademarks of their respective holders.
32 All rights reserved.
33 */
34 
35 #ifndef __SLOW_MENU__
36 #define __SLOW_MENU__
37 
38 #include <Menu.h>
39 #include <MenuItem.h>
40 #include <Debug.h>
41 
42 // SlowMenu is a convenience class that makes it easier to
43 // use the AddDynamicItem callback to implement a menu that can
44 // checks periodically between creating new items and quits
45 // early if needed
46 
47 namespace BPrivate {
48 
49 class BSlowMenu : public BMenu {
50 	public:
51 		BSlowMenu(const char *title, menu_layout layout = B_ITEMS_IN_COLUMN);
52 
53 	protected:
54 		virtual bool StartBuildingItemList();
55 			// set up state to start building the item list
56 			// returns false if setup failed
57 		virtual bool AddNextItem() = 0;
58 			// returns false if done
59 		virtual void DoneBuildingItemList() = 0;
60 			// default version adds items from itemList to menu and deletes
61 			// the list; override to sort items first, etc.
62 
63 		virtual void ClearMenuBuildingState() = 0;
64 
65 	protected:
66 		virtual bool AddDynamicItem(add_state state);
67 			// this is the callback from BMenu, you shouldn't need to override this
68 
69 		bool fMenuBuilt;
70 };
71 
72 } // namespace BPrivate
73 
74 using namespace BPrivate;
75 
76 #endif	/* __SLOW_MENU__ */
77