xref: /haiku/src/kits/tracker/FilePanelPriv.h (revision 2cad94c1c30b6223ad8c08710b26e071d32e9979)
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 BorderedView;
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 SetNodeFlavors(uint32 nodeFlavors) { fNodeFlavors = nodeFlavors; }
82 	void SetSaveText(const char* text);
83 	void SetButtonLabel(file_panel_button, const char* text);
84 	void SetTo(const entry_ref* ref);
85 	virtual void SelectionChanged();
86 	void HandleOpenButton();
87 	void HandleSaveButton();
88 	void Rewind();
89 	bool IsSavePanel() const;
90 	void Refresh();
91 	const BMessenger* Target() const;
92 	BRefFilter* Filter() const;
93 
94 	void SetTarget(BMessenger);
95 	void SetMessage(BMessage* message);
96 
97 	virtual status_t GetNextEntryRef(entry_ref*);
98 	virtual void MessageReceived(BMessage*);
99 
100 	void SetHideWhenDone(bool);
101 	bool HidesWhenDone(void);
102 
103 	bool TrackingMenu() const;
104 
105 protected:
106 	BPoseView* NewPoseView(Model* model, uint32);
107 	virtual	void Init(const BMessage* message = NULL);
108 	virtual	void SaveState(bool hide = true);
109 	virtual	void SaveState(BMessage &) const;
110 	virtual void RestoreState();
111 	virtual void RestoreWindowState(AttributeStreamNode*);
112 	virtual void RestoreWindowState(const BMessage&);
113 	virtual void RestoreState(const BMessage&);
114 
115 	virtual void AddFileContextMenus(BMenu*);
116 	virtual void AddWindowContextMenus(BMenu*);
117 	virtual void AddDropContextMenus(BMenu*);
118 	virtual void AddVolumeContextMenus(BMenu*);
119 
120 	virtual void SetupNavigationMenu(const entry_ref*, BMenu*);
121 	virtual void OpenDirectory();
122 	virtual void OpenParent();
123 	virtual void WindowActivated(bool state);
124 
125 	static filter_result FSFilter(BMessage*, BHandler**, BMessageFilter*);
126 	static filter_result MessageDropFilter(BMessage*, BHandler**,
127 		BMessageFilter*);
128 
129 	int32 ShowCenteredAlert(const char* text, const char* button1,
130 		const char* button2 = NULL, const char* button3 = NULL);
131 
132 private:
133 	bool SwitchDirToDesktopIfNeeded(entry_ref &ref);
134 	bool CanOpenParent() const;
135 	void SwitchDirMenuTo(const entry_ref* ref);
136 	void AdjustButton();
137 	bool SelectChildInParent(const entry_ref* parent,
138 		const node_ref* child);
139 	void OpenSelectionCommon(BMessage*);
140 
141 	bool fIsSavePanel;
142 	uint32 fNodeFlavors;
143 	BView* fBackView;
144 	BDirMenu* fDirMenu;
145 	BMenuField* fDirMenuField;
146 	BTextControl* fTextControl;
147 	BMessenger fTarget;
148 	BFilePanel* fClientObject;
149 	int32 fSelectionIterator;
150 	BMessage* fMessage;
151 	BString fButtonText;
152 	bool fHideWhenDone;
153 	bool fIsTrackingMenu;
154 
155 	typedef BContainerWindow _inherited;
156 };
157 
158 
159 class BFilePanelPoseView : public BPoseView {
160 public:
161 	BFilePanelPoseView(Model*);
162 
163 	virtual bool IsFilePanel() const;
164 	virtual bool FSNotification(const BMessage*);
165 
166 	void SetIsDesktop(bool);
167 
168 protected:
169 	// don't do any volume watching and memtamime watching in file panels
170 	// for now
171 	virtual void StartWatching();
172 	virtual void StopWatching();
173 
174 	virtual void RestoreState(AttributeStreamNode*);
175 	virtual void RestoreState(const BMessage &);
176 	virtual void SavePoseLocations(BRect* = NULL);
177 
178 	virtual EntryListBase* InitDirentIterator(const entry_ref*);
179 	virtual void AddPosesCompleted();
180 	virtual bool IsDesktopView() const;
181 
182 	void ShowVolumes(bool visible, bool showShared);
183 
184 	void AdaptToVolumeChange(BMessage*);
185 	void AdaptToDesktopIntegrationChange(BMessage*);
186 
187 private:
188 	bool fIsDesktop;
189 		// This flags makes the distinction between the Desktop as
190 		// the root of the world and "/boot/home/Desktop" to which
191 		// we might have navigated from the home dir.
192 
193 	typedef BPoseView _inherited;
194 };
195 
196 
197 // inlines follow
198 
199 inline bool
200 BFilePanelPoseView::IsFilePanel() const
201 {
202 	return true;
203 }
204 
205 
206 inline bool
207 TFilePanel::IsSavePanel() const
208 {
209 	return fIsSavePanel;
210 }
211 
212 
213 inline const BMessenger*
214 TFilePanel::Target() const
215 {
216 	return &fTarget;
217 }
218 
219 
220 inline void
221 TFilePanel::Refresh()
222 {
223 	fPoseView->Refresh();
224 }
225 
226 
227 inline bool
228 TFilePanel::HidesWhenDone(void)
229 {
230 	return fHideWhenDone;
231 }
232 
233 
234 inline void
235 TFilePanel::SetHideWhenDone(bool on)
236 {
237 	fHideWhenDone = on;
238 }
239 
240 
241 inline bool
242 TFilePanel::TrackingMenu() const
243 {
244 	return fIsTrackingMenu;
245 }
246 
247 } // namespace BPrivate
248 
249 using namespace BPrivate;
250 
251 
252 #endif	// _FILE_PANEL_PRIV_H
253