Derived From:BListItem
Mix-in Classes:
Declared In:interface/ListItem.h
Class Overview

Constructor and Destructor


BStringItem(const char* text,
            uint32 level = 0,
            bool expanded = true);
BStringItem(BMessage* archive);

Initializes the BStringItem by making a copy of the text string passed as an argument. This is the string the item will display. The level and expanded arguments are passed unchanged to the BListItem constructor; see that function for an explanation.


virtual ~BStringItem();

Frees the text the item displays.

Member Functions


virtual status_t Archive(BMessagearchive,
                         bool deep = true) const;

Calls the inherited version of Archive() and stores the BStringItem in the BMessage archive.

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


virtual void DrawItem(BViewowner,
                      BRect frame,
                      bool complete = false);

Draws the text string, dimming it if the item is disabled and highlighting it if the item is selected.

See also: BListItem::DrawItem()

SetText(), Text()

virtual void SetText(const char* text);const char* Text() const;

These functions set and return the text that the BStringItem draws. SetText() copies the string it's passed. Text() returns a pointer to the string owned by the BStringItem.


virtual void Update(BViewowner,
                    const BFontfont);

Overrides the BListItem version of Update() to recalculate the width and height of the BStringItem and the placement of the text. The width of the item is based on the width of the owner BView. The height and text placement are based on the owner's font. The item must be tall enough to display the string in the current font.

Static Functions


static BArchivableInstantiate(BMessagearchive);

Returns a new BStringItem 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 archived data for a BStringItem, Instantiate() returns NULL.

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

Archived Fields

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

FieldType codeDescription
_labelB_STRING_TYPEString text (present only if it is not NULL).
Creative Commons License
Legal Notice
This work is licensed under a Creative Commons Attribution-Non commercial-No Derivative Works 3.0 License.