xref: /haiku/src/apps/deskbar/BarView.h (revision 5bd0fbd13a1e832f91643aaa921fbc0879abd518)
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
30 trademarks of Be Incorporated in the United States and other countries. Other
31 brand product names are registered trademarks or trademarks of their respective
32 holders.
33 All rights reserved.
34 */
35 #ifndef BARVIEW_H
36 #define BARVIEW_H
37 
38 
39 #include <Deskbar.h>
40 #include <View.h>
41 
42 #include "NavMenu.h"
43 #include "ObjectList.h"
44 
45 
46 const uint32 kStateChanged = 'stch';
47 
48 
49 enum DeskbarShelf {
50 	B_DESKBAR_ANY_SHELF = 0,
51 	B_DESKBAR_TRAY = 1
52 };
53 
54 enum {
55 	kMiniState = 0,
56 	kExpandoState = 1,
57 	kFullState = 2
58 };
59 
60 
61 const float kMiniHeight = 46.0f;
62 const float kHModeHeight = 21.0f;
63 const float kMenuBarHeight = 21.0f;
64 const float kStatusHeight = 22.0f;
65 const float kHiddenDimension = 1.0f;
66 const float kMaxPreventHidingDist = 80.0f;
67 
68 
69 class BShelf;
70 class TBarApp;
71 class TBarMenuBar;
72 class TExpandoMenuBar;
73 class TReplicantTray;
74 class TDragRegion;
75 class TResizeControl;
76 class TInlineScrollView;
77 class TTeamMenuItem;
78 
79 class TBarView : public BView {
80 public:
81 							TBarView(BRect frame, bool vertical, bool left,
82 								bool top, int32 state, float width);
83 							~TBarView();
84 
85 	virtual	void			AttachedToWindow();
86 	virtual	void			DetachedFromWindow();
87 
88 	virtual	void			Draw(BRect updateRect);
89 
90 	virtual	void			MessageReceived(BMessage* message);
91 
92 	virtual	void			MouseMoved(BPoint where, uint32 transit,
93 								const BMessage* dragMessage);
94 	virtual	void			MouseDown(BPoint where);
95 
96 			void			SaveSettings();
97 
98 			void			UpdatePlacement();
99 			void			ChangeState(int32 state, bool vertical, bool left,
100 								bool top, bool aSync = false);
101 
102 			void			RaiseDeskbar(bool raise);
103 			void			HideDeskbar(bool hide);
104 
105 	// window placement methods
106 			bool			Vertical() const { return fVertical; };
107 			bool			Left() const { return fLeft; };
108 			bool			Top() const { return fTop; };
109 			bool			AcrossTop() const { return fTop && !fVertical; };
110 			bool			AcrossBottom() const
111 								{ return !fTop && !fVertical; };
112 
113 	// window state methods
114 			bool			ExpandoState() const
115 								{ return fState == kExpandoState; };
116 			bool			FullState() const { return fState == kFullState; };
117 			bool			MiniState() const { return fState == kMiniState; };
118 			int32			State() const { return fState; };
119 
120 	// drag and drop methods
121 			void			CacheDragData(const BMessage* incoming);
122 			status_t		DragStart();
123 	static	bool			MenuTrackingHook(BMenu* menu, void* castToThis);
124 			void			DragStop(bool full = false);
125 			TrackingHookData*	GetTrackingHookData();
126 			bool			Dragging() const;
127 			const			BMessage* DragMessage() const;
128 			BObjectList<BString>*	CachedTypesList() const;
129 			bool			AppCanHandleTypes(const char* signature);
130 			void			SetDragOverride(bool);
131 			bool			DragOverride();
132 			bool			InvokeItem(const char* signature);
133 
134 			void			HandleDeskbarMenu(BMessage* targetmessage);
135 
136 			status_t		ItemInfo(int32 id, const char** name,
137 								DeskbarShelf* shelf);
138 			status_t		ItemInfo(const char* name, int32* id,
139 								DeskbarShelf* shelf);
140 
141 			bool			ItemExists(int32 id, DeskbarShelf shelf);
142 			bool			ItemExists(const char* name, DeskbarShelf shelf);
143 
144 			int32			CountItems(DeskbarShelf shelf);
145 
146 			BSize			MaxItemSize(DeskbarShelf shelf);
147 
148 			status_t		AddItem(BMessage* archive, DeskbarShelf shelf,
149 								int32* id);
150 			status_t		AddItem(BEntry* entry, DeskbarShelf shelf,
151 								int32* id);
152 
153 			void			RemoveItem(int32 id);
154 			void			RemoveItem(const char* name, DeskbarShelf shelf);
155 
156 			BRect			OffsetIconFrame(BRect rect) const;
157 			BRect			IconFrame(int32 id) const;
158 			BRect			IconFrame(const char* name) const;
159 
160 			void			GetPreferredWindowSize(BRect screenFrame,
161 								float* width, float* height);
162 			void			SizeWindow(BRect screenFrame);
163 			void			PositionWindow(BRect screenFrame);
164 
165 			void			CheckForScrolling();
166 
167 			TExpandoMenuBar*	ExpandoMenuBar() const;
168 			TBarMenuBar*		BarMenuBar() const;
169 			TDragRegion*		DragRegion() const { return fDragRegion; }
170 			TReplicantTray*		ReplicantTray() const { return fReplicantTray; }
171 
172 private:
173 	friend class TBarApp;
174 	friend class TDeskbarMenu;
175 	friend class PreferencesWindow;
176 
177 			status_t		SendDragMessage(const char* signature,
178 								entry_ref* ref = NULL);
179 
180 			void			PlaceDeskbarMenu();
181 			void			PlaceTray(bool vertSwap, bool leftSwap);
182 			void			PlaceApplicationBar();
183 
184 			void			_ChangeState(BMessage* message);
185 
186 			TBarApp*			fBarApp;
187 			TInlineScrollView*	fInlineScrollView;
188 			TBarMenuBar*		fBarMenuBar;
189 			TExpandoMenuBar*	fExpandoMenuBar;
190 
191 			int32			fTrayLocation;
192 			TDragRegion*	fDragRegion;
193 			TResizeControl*	fResizeControl;
194 			TReplicantTray*	fReplicantTray;
195 
196 			bool			fVertical : 1;
197 			bool			fTop : 1;
198 			bool			fLeft : 1;
199 			int32			fState;
200 
201 			bigtime_t		fPulseRate;
202 			bool			fRefsRcvdOnly;
203 			BMessage*		fDragMessage;
204 			BObjectList<BString>*	fCachedTypesList;
205 			TrackingHookData		fTrackingHookData;
206 
207 			uint32			fMaxRecentDocs;
208 			uint32			fMaxRecentApps;
209 
210 			TTeamMenuItem*	fLastDragItem;
211 			BMessageFilter*	fMouseFilter;
212 };
213 
214 
215 inline TExpandoMenuBar*
216 TBarView::ExpandoMenuBar() const
217 {
218 	return fExpandoMenuBar;
219 }
220 
221 
222 inline TBarMenuBar*
223 TBarView::BarMenuBar() const
224 {
225 	return fBarMenuBar;
226 }
227 
228 
229 inline bool
230 TBarView::Dragging() const
231 {
232 	return (fCachedTypesList && fDragMessage);
233 }
234 
235 
236 inline const BMessage*
237 TBarView::DragMessage() const
238 {
239 	return fDragMessage;
240 }
241 
242 
243 inline BObjectList<BString>*
244 TBarView::CachedTypesList() const
245 {
246 	return fCachedTypesList;
247 }
248 
249 
250 #endif	// BARVIEW_H
251