The Interface Kit: BStringView

The Interface Kit Table of Contents | The Interface Kit Index

# BStringView

Derived from: public BView

Declared in: be/interface/StringView.h

Library: libbe.so

###### Summary

A BStringView object draws a string that the user can neither select nor edit. BStringView object are typically used as labels for your app's UI. If you need to present text that can be selected and/or edited, wse a BTextView object.

## Constructor and Destructor

### BStringView()

`BStringView(` BRect frame, const char *name, const char *text, uint32 resizingMode = `B_FOLLOW_LEFT` | `B_FOLLOW_TOP`, uint32 flags = `B_WILL_DRAW``)`
`BStringView(` BMessage *archive`)`

Initializes the BStringView by assigning it a text string and the system plain font (`be_plain_font`). The frame, name, resizingMode, and flags arguments are passed unchanged to the BView constructor.

The frame rectangle needs to be large enough to display the entire string in the current font. The string is drawn at the bottom of the frame rectangle and, by default, is aligned to the left side. A different horizontal alignment can be set by calling `SetAlignment()`.

### ~BStringView()

virtual `~BStringView() `

Frees the text string.

## Static Functions

### Instantiate() see BArchivable::Instantiate()

## Member Functions

### Alignment() see SetAlignment()

"Archived Fields"

### Archive() , see

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

Calls the inherited version of `Archive()`, then adds the string and its alignment to the BMessage archive.

### AttachedToWindow()

virtual void `AttachedToWindow(`void`) `

Sets the BStringView's low color and its background view color to match the background color of its new parent view.

See also: `BView::AttachedToWindow()`

### Draw()

virtual void `Draw(` BRect updateRect`) `

Draws the string along the bottom of the BStringView's frame rectangle in the current high color.

### SetAlignment() , Alignment()

void `SetAlignment(`alignment flag`) `
alignment `Alignment(`void`)` const

These functions align the string within the BStringView's frame rectangle and return the current alignment. The alignment flag can be:

`B_ALIGN_LEFT` | The string is aligned at the left side of the frame rectangle.
`B_ALIGN_RIGH T` | The string is aligned at the right side of the frame rectangle.
`B_ALIGN_CEN TER` | The string is aligned so that the center of the string falls midway between the left and right sides of the frame rectangle.

The default is `B_ALIGN_LEFT`.

### SetText() , Text()

void `SetText(`const char *string`) `
const char *`Text(`void`)` const

These functions set and return the text string that the BStringView draws. `SetText()` frees the previous string and copies string to replace it. `Text()` returns the null-terminated string.

## Archived Fields

The `Archive()` function adds the following fields to its BMessage argument:

Field | Type code | Meaning
--- | --- | ---
"_text" | `B_STRING_TYPE` | Text displayed in the view (present only if it is not `NULL`).
"_align" | `B_INT32_TYPE` | Alignment of text in frame.

The Interface Kit Table of Contents | The Interface Kit Index

The Be Book,
...in lovely HTML...
for BeOS Release 5.

Copyright © 2000 Be, Inc. All rights reserved..