xref: /haiku/src/kits/tracker/BackgroundImage.h (revision 529cd177b573aaba391c8adc9c9f5ad76a14bf81)
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 //  Classes used for setting up and managing background images
36 
37 
38 #ifndef _BACKGROUND_IMAGE_H
39 #define _BACKGROUND_IMAGE_H
40 
41 
42 #include <ObjectList.h>
43 #include <String.h>
44 
45 
46 class BNode;
47 class BView;
48 class BBitmap;
49 
50 namespace BPrivate {
51 
52 class BackgroundImage;
53 class BPoseView;
54 
55 extern const char* kBackgroundImageInfo;
56 extern const char* kBackgroundImageInfoOffset;
57 extern const char* kBackgroundImageInfoTextOutline;
58 extern const char* kBackgroundImageInfoMode;
59 extern const char* kBackgroundImageInfoWorkspaces;
60 extern const char* kBackgroundImageInfoPath;
61 
62 const uint32 kRestoreBackgroundImage = 'Tbgr';
63 
64 class BackgroundImage {
65 	// This class knows everything about which bitmap to use for a given
66 	// view and how.
67 	// Unlike other windows, the Desktop window can have different backgrounds
68 	// for each workspace
69 public:
70 
71 	enum Mode {
72 		kAtOffset,
73 		kCentered,			// only works on Desktop
74 		kScaledToFit,		// only works on Desktop
75 		kTiled
76 	};
77 
78 	class BackgroundImageInfo {
79 		// element of the per-workspace list
80 	public:
81 		BackgroundImageInfo(uint32 workspace, BBitmap* bitmap, Mode mode,
82 			BPoint offset, bool textWidgetOutline);
83 		~BackgroundImageInfo();
84 
85 		uint32 fWorkspace;
86 		BBitmap* fBitmap;
87 		Mode fMode;
88 		BPoint fOffset;
89 		bool fTextWidgetOutline;
90 	};
91 
92 	static BackgroundImage* GetBackgroundImage(const BNode* node,
93 		bool isDesktop);
94 		// create a BackgroundImage object by reading it from a node
95 	virtual ~BackgroundImage();
96 
97 	void Show(BView* view, int32 workspace);
98 		// display the right background for a given workspace
99 	void Remove();
100 		// remove the background from it's current view
101 
102 	void WorkspaceActivated(BView* view, int32 workspace, bool state);
103 		// respond to a workspace change
104 	void ScreenChanged(BRect rect, color_space space);
105 		// respond to a screen size change
106 	static BackgroundImage* Refresh(BackgroundImage* oldBackgroundImage,
107 		const BNode* fromNode, bool desktop, BPoseView* poseView);
108 		// respond to a background image setting change
109 
110 private:
111 	BackgroundImageInfo* ImageInfoForWorkspace(int32) const;
112 	void Show(BackgroundImageInfo*, BView* view);
113 
114 	BackgroundImage(const BNode*, bool);
115 		// no public constructor, GetBackgroundImage factory function is
116 		// used instead
117 
118 	void Add(BackgroundImageInfo*);
119 
120 	float BRectRatio(BRect rect);
121 	float BRectHorizontalOverlap(BRect hostRect, BRect resizedRect);
122 	float BRectVerticalOverlap(BRect hostRect, BRect resizedRect);
123 
124 	bool fIsDesktop;
125 	BNode fDefinedByNode;
126 	BView* fView;
127 	BackgroundImageInfo* fShowingBitmap;
128 
129 	BObjectList<BackgroundImageInfo> fBitmapForWorkspaceList;
130 };
131 
132 } // namespace BPrivate
133 
134 using namespace BPrivate;
135 
136 
137 #endif	// _BACKGROUND_IMAGE_H
138