The Interface Kit: BShelf

Derived from: public BHandler

Declared in: be/interface/Shelf.h

Library: libbe.so


Overview

xxxx[[]]xxxx


Constructor and Destructor


BShelf()


      BShelf(const entry_ref *ref, BView *view, bool allowsDragging = true, const char *name = NULL) 
      BShelf(BDataIO *stream, BView *view, bool allowsDragging = true, const char *name = NULL) 
      BShelf(BView *view, bool allowsDragging = true, const char *name = NULL) 
      BShelf(BMessage *archive) 

xxxx[[]]xxxx

Initializes the BShelf object so that it serves a container view and can take archived BView objects from a ref source in the file system or from a data stream. If a ref or stream is not mentioned, the BShelf will look for objects only in B_ARCHIVED_OBJECT messages intended for the container view, usually messages that are dropped on the view.

If the allowsDragging flag is true, the user can drag replicant BViews from place to place in the container. If the flag is false, the BViews must stay where they're first put.

The name identifies the BShelf; it's the same as the name declared in the BHandler class. BViews may distinguish between containers by the shelf name and permit themselves to be replicated by one BShelf rather than another.

xxxx[[incomplete]]xxxx


~BShelf()


      virtual ~BShelf(void)

xxx[[]]xxx


Static Functions


Instantiate()


      static BShelf *Instantiate(BMessage *archive) 

Returns a new BShelf object, allocated by new and created with the version of the constructor that takes a BMessage archive. However, if the archive message doesn't contain data for a BShelf object, a new object isn't created and the function returns NULL.

See also: BArchivable::Instantiate(), instantiate_object(), Archive()


Member Functions


AddReplicant()


      filter_result AddReplicant(BMessage *archive, BPoint point)

xxxx[[]]xxxx


AdjustReplicantBy()


      virtual BPoint AdjustReplicantBy(BRect offsets, BMessage *archive) const

xxxx[[]]xxxx


AllowsDragging()


      bool AllowsDragging(void)

xxxx[[]]xxxx


Archive()


      virtual status_t Archive(BMessage *archive, bool deep = true) const

xxxx[[]]xxxx

See also: BArchivable::Archive(), Instantiate() static function


CanAcceptReplicantMessage(), CanAcceptReplicantView()


      virtual bool CanAcceptReplicantMessage(BMessage *archive) const
      virtual bool CanAcceptReplicantView(BRect rect, BView *view, BMessage *archive) const

xxxx[[]]xxxx


IsDirty() see SetDirty()


MessageReceived()


      virtual void MessageReceived(BMessage *message)

xxxx[[]]xxxx


Save()


      status_t Save(void)

xxxx[[]]xxxx


SetDirty(), IsDirty()


      virtual void SetDirty(bool flag)

      bool IsDirty(void)

xxxx[[]]xxxx






The Be Book, in lovely HTML, for the BeOS Preview Release.

Copyright © 1997 Be, Inc. All rights reserved.

Be is a registered trademark; BeOS, BeBox, BeWare, GeekPort, the Be logo, and the BeOS logo are trademarks of Be, Inc.

Last modified September 18, 1997.