The Be Book - Classes And Methods - The Interface Kit
| Class Overview |
BBox(BRect frame,
const char* name = NULL,
uint32 resizingMode = B_FOLLOW_LEFT | B_FOLLOW_TOP,
uint32 flags = B_WILL_DRAW | B_FRAME_EVENTS | B_NAVIGABLE_JUMP,
border_style border = B_FANCY_BORDER);
BBox(BMessage* archive);
Initializes the BBox by passing the frame, name, resizingMode, and flags
to the BView constructor, and sets the style of its border to border.
Three border styles are possible:
| Constant | Description |
|---|---|
| The border is a simple line, lighter on the left and top than on the right and bottom so that the box looks raised from the surrounding surface. |
| The border is a fancier line that looks like a 3D groove inset into the surrounding surface of the view. |
| There is no border. This option is not that useful for a
|
The constructor also sets the font for displaying the BBox's label to the
system bold font (be_bold_font). However, the new object doesn't have a
label; call
SetLabel()
to assign it one.
virtual Archive(BMessage* archive,
bool deep = true) const;
Stores the BBox in the
BMessage archive.
See also:
BArchivable::Archive(),
Instantiate()
static function
virtual void AttachedToWindow();
Makes the BBox's background view color and its low color match the
background color of its new parent.
virtual void Draw(BRectupdateRect);Draws the box and its label. This function is called automatically in response to update messages.
virtual void FrameResized(float width,
float height);Makes sure that the parts of the box that change when it's resized are redrawn.
See also: BView::FrameResized()
virtual void SetBorder(border_style border);border_style Border() const;
These functions set and return the style of border the BBox
draws—B_PLAIN_BORDER, B_FANCY_BORDER, or B_NO_BORDER. The border
style is initially set by the BBox constructor.
void SetLabel(const char* string);
status_t SetLabel(BView* viewLabel);
const char* Label() const;BView* LabelView() const;
These functions set and return the label that's displayed along the top
edge of the box.
SetLabel() copies string and makes it the BBox's label,
freeing the previous label, if any. If string is NULL, it removes the
current label and frees it.
Alternately, you can use the second form of SetLabel() to specify a view
to be used as the BBox's label. This view can be anything, including
controls.
Label() returns a pointer to the
BBox's current label, or NULL if it
doesn't have one (or the label is a view).
LabelView() returns a pointer to the
BView that's being used as the
BBox's label, or NULL if
either there is no label, or the label is a string.
| Return Code | Description |
|---|---|
| No error occurred. |
No other errors are returned.
static BArchivable* Instantiate(BMessage* archive);
Returns a new BBox 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 BBox object, this
function returns NULL.
See also:
BArchivable::Instantiate(),
instantiate_object(),
Archive()()
