xref: /haiku/src/kits/tracker/FilePanelPriv.h (revision fae7ea18b62865f5e1159e1678c851d3aa1ddce0)
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 #ifndef _FILE_PANEL_PRIV_H
35 #define _FILE_PANEL_PRIV_H
36 
37 
38 #include <FilePanel.h>
39 
40 #include "ContainerWindow.h"
41 #include "PoseView.h"
42 #include "TaskLoop.h"
43 
44 
45 class BTextControl;
46 class BFilePanel;
47 class BRefFilter;
48 class BMessenger;
49 class BMenuField;
50 
51 namespace BPrivate {
52 
53 class BackgroundView;
54 class BDirMenu;
55 class AttributeStreamNode;
56 class BFilePanelPoseView;
57 
58 class TFilePanel : public BContainerWindow {
59 public:
60 	TFilePanel(file_panel_mode = B_OPEN_PANEL,
61 		BMessenger* target = NULL, const BEntry* startDirectory = NULL,
62 		uint32 nodeFlavors = B_FILE_NODE | B_SYMLINK_NODE,
63 		bool multipleSelection = true, BMessage* = NULL, BRefFilter* = NULL,
64 		uint32 containerWindowFlags = 0,
65 		window_look look = B_DOCUMENT_WINDOW_LOOK,
66 		window_feel feel = B_NORMAL_WINDOW_FEEL,
67 		bool hideWhenDone = true);
68 
69 	virtual ~TFilePanel();
70 
71 	BFilePanelPoseView* PoseView() const;
72 
73 	virtual bool QuitRequested();
74 	virtual void MenusBeginning();
75 	virtual void MenusEnded();
76 	virtual void DispatchMessage(BMessage* message, BHandler* handler);
77 	virtual void ShowContextMenu(BPoint, const entry_ref*, BView*);
78 
79 	void SetClientObject(BFilePanel*);
80 	void SetRefFilter(BRefFilter*);
81 	void SetSaveText(const char* text);
82 	void SetButtonLabel(file_panel_button, const char* text);
83 	void SetTo(const entry_ref* ref);
84 	virtual void SelectionChanged();
85 	void HandleOpenButton();
86 	void HandleSaveButton();
87 	void Rewind();
88 	bool IsSavePanel() const;
89 	void Refresh();
90 	const BMessenger* Target() const;
91 	BRefFilter* Filter() const;
92 
93 	void SetTarget(BMessenger);
94 	void SetMessage(BMessage* message);
95 
96 	virtual status_t GetNextEntryRef(entry_ref*);
97 	virtual void MessageReceived(BMessage*);
98 
99 	void SetHideWhenDone(bool);
100 	bool HidesWhenDone(void);
101 
102 	bool TrackingMenu() const;
103 
104 protected:
105 	BPoseView* NewPoseView(Model* model, BRect rect, uint32 viewMode);
106 	virtual	void Init(const BMessage* message = NULL);
107 	virtual	void SaveState(bool hide = true);
108 	virtual	void SaveState(BMessage &) const;
109 	virtual void RestoreState();
110 	virtual void RestoreWindowState(AttributeStreamNode*);
111 	virtual void RestoreWindowState(const BMessage&);
112 	virtual void RestoreState(const BMessage&);
113 
114 	virtual void AddFileContextMenus(BMenu*);
115 	virtual void AddWindowContextMenus(BMenu*);
116 	virtual void AddDropContextMenus(BMenu*);
117 	virtual void AddVolumeContextMenus(BMenu*);
118 
119 	virtual void SetupNavigationMenu(const entry_ref*, BMenu*);
120 	virtual void OpenDirectory();
121 	virtual void OpenParent();
122 	virtual void WindowActivated(bool state);
123 
124 	static filter_result FSFilter(BMessage*, BHandler**, BMessageFilter*);
125 	static filter_result MessageDropFilter(BMessage*, BHandler**,
126 		BMessageFilter*);
127 
128 	int32 ShowCenteredAlert(const char* text, const char* button1,
129 		const char* button2 = NULL, const char* button3 = NULL);
130 
131 private:
132 	friend class BackgroundView;
133 
134 	bool SwitchDirToDesktopIfNeeded(entry_ref &ref);
135 	bool CanOpenParent() const;
136 	void SwitchDirMenuTo(const entry_ref* ref);
137 	void AdjustButton();
138 	bool SelectChildInParent(const entry_ref* parent,
139 		const node_ref* child);
140 	void OpenSelectionCommon(BMessage*);
141 
142 	bool fIsSavePanel;
143 	uint32 fNodeFlavors;
144 	BackgroundView* fBackView;
145 	BDirMenu* fDirMenu;
146 	BMenuField* fDirMenuField;
147 	BTextControl* fTextControl;
148 	BMessenger fTarget;
149 	BFilePanel* fClientObject;
150 	int32 fSelectionIterator;
151 	BMessage* fMessage;
152 	BString fButtonText;
153 	bool fHideWhenDone;
154 	bool fIsTrackingMenu;
155 
156 	typedef BContainerWindow _inherited;
157 };
158 
159 
160 class BFilePanelPoseView : public BPoseView {
161 public:
162 	BFilePanelPoseView(Model*, BRect, uint32 resizeMask = B_FOLLOW_ALL);
163 
164 	virtual bool IsFilePanel() const;
165 	virtual bool FSNotification(const BMessage*);
166 
167 	void SetIsDesktop(bool);
168 
169 protected:
170 	// don't do any volume watching and memtamime watching in file panels
171 	// for now
172 	virtual void StartWatching();
173 	virtual void StopWatching();
174 
175 	virtual void RestoreState(AttributeStreamNode*);
176 	virtual void RestoreState(const BMessage &);
177 	virtual void SavePoseLocations(BRect* = NULL);
178 
179 	virtual EntryListBase* InitDirentIterator(const entry_ref*);
180 	virtual void AddPosesCompleted();
181 	virtual bool IsDesktopView() const;
182 
183 	void ShowVolumes(bool visible, bool showShared);
184 
185 	void AdaptToVolumeChange(BMessage*);
186 	void AdaptToDesktopIntegrationChange(BMessage*);
187 
188 private:
189 	bool fIsDesktop;
190 		// This flags makes the distinction between the Desktop as
191 		// the root of the world and "/boot/home/Desktop" to which
192 		// we might have navigated from the home dir.
193 
194 	typedef BPoseView _inherited;
195 };
196 
197 
198 // inlines follow
199 
200 inline bool
201 BFilePanelPoseView::IsFilePanel() const
202 {
203 	return true;
204 }
205 
206 
207 inline bool
208 TFilePanel::IsSavePanel() const
209 {
210 	return fIsSavePanel;
211 }
212 
213 
214 inline const BMessenger*
215 TFilePanel::Target() const
216 {
217 	return &fTarget;
218 }
219 
220 
221 inline void
222 TFilePanel::Refresh()
223 {
224 	fPoseView->Refresh();
225 }
226 
227 
228 inline bool
229 TFilePanel::HidesWhenDone(void)
230 {
231 	return fHideWhenDone;
232 }
233 
234 
235 inline void
236 TFilePanel::SetHideWhenDone(bool on)
237 {
238 	fHideWhenDone = on;
239 }
240 
241 
242 inline bool
243 TFilePanel::TrackingMenu() const
244 {
245 	return fIsTrackingMenu;
246 }
247 
248 } // namespace BPrivate
249 
250 using namespace BPrivate;
251 
252 
253 #endif	// _FILE_PANEL_PRIV_H
254