src/kits/tracker/Pose.h

   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 _POSE_H
  35 #define _POSE_H
  36
  37
  38 #include <Region.h>
  39
  40 #include "TextWidget.h"
  41 #include "Model.h"
  42 #include "Utilities.h"
  43
  44
  45 namespace BPrivate {
  46
  47 class BPoseView;
  48 class BTextWidget;
  49
  50 enum {
  51         B_NAME_WIDGET,
  52         B_ALL_WIDGETS
  53 };
  54
  55
  56 class BPose {
  57 public:
  58         BPose(Model* adopt, BPoseView*, uint32 clipboardMode,
  59                 bool selected = false);
  60         virtual ~BPose();
  61
  62         BTextWidget* AddWidget(BPoseView*, BColumn*);
  63         BTextWidget* AddWidget(BPoseView*, BColumn*,
  64                 ModelNodeLazyOpener &opener);
  65         void RemoveWidget(BPoseView*, BColumn*);
  66         void SetLocation(BPoint, const BPoseView*);
  67         void MoveTo(BPoint, BPoseView*, bool invalidate = true);
  68
  69         void Draw(BRect poseRect, const BRect& updateRect, BPoseView*,
  70                 bool fullDraw = true);
  71         void Draw(BRect poseRect, const BRect& updateRect, BPoseView*,
  72                 BView* drawView, bool fullDraw, BPoint offset, bool selected);
  73         void DeselectWithoutErasingBackground(BRect rect,
  74                 BPoseView* poseView);
  75                 // special purpose draw call for deselecting over a textured
  76                 // background
  77
  78         void DrawBar(BPoint where, BView* view, icon_size which);
  79
  80         void DrawIcon(BPoint where, BView* view, icon_size which, bool direct,
  81                 bool drawUnselected = false);
  82         void DrawToggleSwitch(BRect, BPoseView*);
  83         void MouseUp(BPoint poseLoc, BPoseView*, BPoint where, int32 index);
  84         Model* TargetModel() const;
  85         Model* ResolvedModel() const;
  86         void Select(bool selected);
  87         bool IsSelected() const;
  88                 // Rename to IsHighlighted
  89         bigtime_t SelectionTime() const;
  90
  91         BTextWidget* ActiveWidget() const;
  92         BTextWidget* WidgetFor(uint32 hashAttr, int32* index = 0) const;
  93         BTextWidget* WidgetFor(BColumn* column, BPoseView* poseView,
  94                 ModelNodeLazyOpener &opener, int32* index = NULL);
  95                 // adds the widget if needed
  96
  97         bool PointInPose(BPoint poseLoc, const BPoseView*, BPoint where,
  98                         BTextWidget** = NULL) const;
  99         bool PointInPose(const BPoseView*, BPoint where) const;
 100         BRect CalcRect(BPoint loc, const BPoseView*,
 101                 bool minimal_rect = false) const;
 102         BRect CalcRect(const BPoseView*) const;
 103         void UpdateAllWidgets(int32 poseIndex, BPoint poseLoc, BPoseView*);
 104         void UpdateWidgetAndModel(Model* resolvedModel, const char* attrName,
 105                         uint32 attrType, int32 poseIndex, BPoint poseLoc,
 106                         BPoseView* view, bool visible);
 107         bool UpdateVolumeSpaceBar(BVolume* volume);
 108         void UpdateIcon(BPoint poseLoc, BPoseView*);
 109
 110         //void UpdateFixedSymlink(BPoint poseLoc, BPoseView*);
 111         void UpdateBrokenSymLink(BPoint poseLoc, BPoseView*);
 112         void UpdateWasBrokenSymlink(BPoint poseLoc, BPoseView* poseView);
 113
 114         void Commit(bool saveChanges, BPoint loc, BPoseView*, int32 index);
 115         void EditFirstWidget(BPoint poseLoc, BPoseView*);
 116         void EditNextWidget(BPoseView*);
 117         void EditPreviousWidget(BPoseView*);
 118
 119         BPoint Location(const BPoseView* poseView) const;
 120         bool DelayedEdit() const;
 121         void SetDelayedEdit(bool delay);
 122         bool ListModeInited() const;
 123         bool HasLocation() const;
 124         bool NeedsSaveLocation() const;
 125         void SetSaveLocation();
 126         bool WasAutoPlaced() const;
 127         void SetAutoPlaced(bool);
 128
 129         uint32 ClipboardMode() const;
 130         void SetClipboardMode(uint32 clipboardMode);
 131 #if DEBUG
 132         void PrintToStream();
 133 #endif
 134
 135 private:
 136         static bool _PeriodicUpdateCallback(BPose* pose, void* cookie);
 137         void EditPreviousNextWidgetCommon(BPoseView* poseView, bool next);
 138         void CreateWidgets(BPoseView*);
 139         bool TestLargeIconPixel(BPoint) const;
 140
 141         Model* fModel;
 142         BObjectList<BTextWidget> fWidgetList;
 143         BPoint fLocation;
 144
 145         uint32 fClipboardMode;
 146         int32 fPercent;
 147         bigtime_t fSelectionTime;
 148
 149         bool fIsSelected : 1;
 150         bool fHasLocation : 1;
 151         bool fNeedsSaveLocation : 1;
 152         bool fListModeInited : 1;
 153         bool fWasAutoPlaced : 1;
 154         bool fBrokenSymLink : 1;
 155         bool fBackgroundClean : 1;
 156 };
 157
 158
 159 inline Model*
 160 BPose::TargetModel() const
 161 {
 162         return fModel;
 163 }
 164
 165
 166 inline Model*
 167 BPose::ResolvedModel() const
 168 {
 169         if (fModel->IsSymLink())
 170                 return fModel->LinkTo() != NULL ? fModel->LinkTo() : fModel;
 171         else
 172                 return fModel;
 173 }
 174
 175
 176 inline bool
 177 BPose::IsSelected() const
 178 {
 179         return fIsSelected;
 180 }
 181
 182
 183 inline void
 184 BPose::Select(bool on)
 185 {
 186         fIsSelected = on;
 187         if (on)
 188                 fSelectionTime = system_time();
 189 }
 190
 191
 192 inline bigtime_t
 193 BPose::SelectionTime()  const
 194 {
 195         return fSelectionTime;
 196 }
 197
 198
 199 inline bool
 200 BPose::NeedsSaveLocation() const
 201 {
 202         return fNeedsSaveLocation;
 203 }
 204
 205
 206 inline void
 207 BPose::SetSaveLocation()
 208 {
 209         fNeedsSaveLocation = true;
 210 }
 211
 212
 213 inline bool
 214 BPose::ListModeInited() const
 215 {
 216         return fListModeInited;
 217 }
 218
 219
 220 inline bool
 221 BPose::WasAutoPlaced() const
 222 {
 223         return fWasAutoPlaced;
 224 }
 225
 226
 227 inline void
 228 BPose::SetAutoPlaced(bool on)
 229 {
 230         fWasAutoPlaced = on;
 231 }
 232
 233
 234 inline bool
 235 BPose::HasLocation() const
 236 {
 237         return fHasLocation;
 238 }
 239
 240
 241 inline void
 242 BPose::Draw(BRect poseRect, const BRect& updateRect, BPoseView* view,
 243         bool fullDraw)
 244 {
 245         Draw(poseRect, updateRect, view, (BView*)view, fullDraw, BPoint(0, 0),
 246                 IsSelected());
 247 }
 248
 249
 250 inline uint32
 251 BPose::ClipboardMode() const
 252 {
 253         return fClipboardMode;
 254 }
 255
 256
 257 inline void
 258 BPose::SetClipboardMode(uint32 clipboardMode)
 259 {
 260         fClipboardMode = clipboardMode;
 261 }
 262
 263 } // namespace BPrivate
 264
 265 using namespace BPrivate;
 266
 267
 268 #endif  // _POSE_H