Public Member Functions | Protected Member Functions | List of all members
BStringView Class Reference

Draws a non-editable single-line text string, most commonly used as a label. More...

Inherits BView.

Public Member Functions

 BStringView (BRect frame, const char *name, const char *text, uint32 resizingMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW)
 Creates a new BStringView object which displays the non-editable text string in the plain system font (be_plain_font). More...
 
 BStringView (const char *name, const char *text, uint32 flags=B_WILL_DRAW)
 Layout constructor. More...
 
 BStringView (BMessage *archive)
 Archive constructor. More...
 
virtual ~BStringView ()
 Destructor method, frees the memory used by the string view. More...
 
virtual void GetPreferredSize (float *_width, float *_height)
 Fills out the preferred width and height of the string view into the _width and _height parameters respectively. More...
 
virtual status_t GetSupportedSuites (BMessage *data)
 Reports the suites of messages and specifiers that derived classes understand. More...
 
virtual BAlignment LayoutAlignment ()
 Returns the alignment used by this view as part of a BLayout. More...
 
virtual void MakeFocus (bool focus=true)
 Makes the string view the current focus view of the window or gives up being the window's focus view. More...
 
virtual BSize MaxSize ()
 Returns the string view's maximum size. More...
 
virtual BSize MinSize ()
 Returns the string view's minimum size. More...
 
virtual BSize PreferredSize ()
 Returns the string view's preferred size. More...
 
virtual void ResizeToPreferred ()
 Resize the string view to its preferred size. More...
 
virtual BHandlerResolveSpecifier (BMessage *message, int32 index, BMessage *specifier, int32 form, const char *property)
 Determine the proper handler for a scripting message. More...
 
virtual void SetFont (const BFont *font, uint32 mask=B_FONT_ALL)
 Sets the font of the string view to font with the font parameters set by mask. More...
 
Text methods
void SetText (const char *text)
 Sets the text string displayed by the string view. More...
 
const char * Text () const
 Returns the text currently set on the string view. More...
 
Alignment methods
void SetAlignment (alignment flag)
 Sets the way text is aligned within the view's frame. More...
 
alignment Alignment () const
 Returns the currently set text alignment flag. More...
 
Hook methods
virtual void AttachedToWindow ()
 Hook method called when the BStringView is attached to a window. More...
 
virtual void DetachedFromWindow ()
 Hook method called when the BStringView is detached from a window. More...
 
virtual void AllAttached ()
 Similar to AttachedToWindow() but this method is triggered after all child views have already been attached to a window. More...
 
virtual void AllDetached ()
 Similar to AttachedToWindow() but this method is triggered after all child views have already been detached from a window. More...
 
virtual void FrameMoved (BPoint newPosition)
 Hook method called when the string view is moved. More...
 
virtual void FrameResized (float newWidth, float newHeight)
 Hook method called when the string view is resized. More...
 
virtual void Draw (BRect bounds)
 Draws the area of the view that intersects updateRect. More...
 
virtual void MessageReceived (BMessage *message)
 Handle message received by the associated looper. More...
 
virtual void MouseDown (BPoint point)
 Hook method called when a mouse button is pressed. More...
 
virtual void MouseUp (BPoint point)
 Hook method called when a mouse button is released. More...
 
virtual void MouseMoved (BPoint point, uint32 transit, const BMessage *dragMessage)
 Hook method called when the mouse is moved. More...
 
- Public Member Functions inherited from BView
 BView (const char *name, uint32 flags, BLayout *layout=NULL)
 Layout constructor. More...
 
 BView (BRect frame, const char *name, uint32 resizingMode, uint32 flags)
 Standard constructor. More...
 
 BView (BMessage *archive)
 Archive constructor. More...
 
virtual ~BView ()
 Destructor method. More...
 
BRect Bounds () const
 Returns the view's frame rectangle in the view's coordinate system. More...
 
uint32 Flags () const
 Return the view flags set in the constructor or by SetFlags(). More...
 
void Flush () const
 Flushes the attached window's connection to App Server. More...
 
BRect Frame () const
 Returns the view's frame rectangle in the parent's coordinate system. More...
 
virtual void Hide ()
 Hides the view without removing it from the view hierarchy. More...
 
bool IsFocus () const
 Returns whether or not the view is the window's current focus view. More...
 
bool IsHidden () const
 Returns whether or not the view is hidden. More...
 
bool IsHidden (const BView *looking_from) const
 Returns whether or not the view is hidden from the perspective of lookingFrom. More...
 
bool IsPrinting () const
 Returns whether or not the view is drawing to a printer. More...
 
BPoint LeftTop () const
 Returns the left top corner point. More...
 
uint32 ResizingMode () const
 Returns the resizing mode flags mask set in the constructor or by SetResizingMode(). More...
 
virtual void SetFlags (uint32 flags)
 Sets the view flags to the flags mask. More...
 
virtual void SetResizingMode (uint32 mode)
 Sets the resizing mode of the view according to the mode mask. More...
 
void SetViewCursor (const BCursor *cursor, bool sync=true)
 Assigns cursor to the view. More...
 
virtual void Show ()
 Shows the view making it visible. More...
 
void Sync () const
 Synchronizes the attached window's connection to App Server. More...
 
BWindowWindow () const
 Returns the window the view is attached to. More...
 
void AddChild (BView *child, BView *before=NULL)
 Adds child to the view hierarchy immediately before before. More...
 
bool AddChild (BLayoutItem *child)
 Add the child layout item to the view hierarchy. More...
 
bool RemoveChild (BView *child)
 Removes child from the view hierarchy. More...
 
int32 CountChildren () const
 Returns the number of child views that this view has. More...
 
BViewChildAt (int32 index) const
 Returns a pointer to the child view found at index. More...
 
BViewNextSibling () const
 Returns a pointer to the next sibling view. More...
 
BViewPreviousSibling () const
 Returns a pointer to the previous sibling view. More...
 
bool RemoveSelf ()
 Removes the view and all child views from the view hierarchy. More...
 
BViewFindView (const char *name) const
 Returns the view in the view hierarchy with the specified name. More...
 
BViewParent () const
 Returns a pointer to the view's parent. More...
 
void ConvertToScreen (BPoint *point) const
 Convert point to the screen's coordinate system in place. More...
 
BPoint ConvertToScreen (BPoint point) const
 Returns point converted to the screen's coordinate system. More...
 
void ConvertFromScreen (BPoint *point) const
 Convert point from the screen's coordinate system to the view's coordinate system in place. More...
 
BPoint ConvertFromScreen (BPoint point) const
 Returns point converted from the screen's coordinate system to the view's coordinate system. More...
 
void ConvertToScreen (BRect *rect) const
 Convert rect to the screen's coordinate system in place. More...
 
BRect ConvertToScreen (BRect rect) const
 Returns rect converted to the screen's coordinate system. More...
 
void ConvertFromScreen (BRect *rect) const
 Convert rect from the screen's coordinate system to the view's coordinate system in place. More...
 
BRect ConvertFromScreen (BRect rect) const
 Returns rect converted from the screen's coordinate system to the view's coordinate system. More...
 
void ConvertToParent (BPoint *point) const
 Convert point to the parent's coordinate system in place. More...
 
BPoint ConvertToParent (BPoint point) const
 Returns point converted to the parent's coordinate system. More...
 
void ConvertFromParent (BPoint *point) const
 Convert point from the parent's coordinate system to the view's coordinate system in place. More...
 
BPoint ConvertFromParent (BPoint point) const
 Returns point converted from the parent's coordinate system to the view's coordinate system. More...
 
void ConvertToParent (BRect *rect) const
 Convert rect to the parent's coordinate system in place. More...
 
BRect ConvertToParent (BRect rect) const
 Returns rect converted to the parent's coordinate system. More...
 
void ConvertFromParent (BRect *rect) const
 Convert rect from the parent's coordinate system to the view's coordinate system in place. More...
 
BRect ConvertFromParent (BRect rect) const
 Returns rect converted from the parent's coordinate system to the view's coordinate system. More...
 
void GetClippingRegion (BRegion *region) const
 Fill out region with the view's clipping region. More...
 
virtual void ConstrainClippingRegion (BRegion *region)
 Set the clipping region the region restricting the area that the view can draw in. More...
 
void ClipToPicture (BPicture *picture, BPoint where=B_ORIGIN, bool sync=true)
 Intersects the current clipping region of the view with the pixels of picture. More...
 
void ClipToInversePicture (BPicture *picture, BPoint where=B_ORIGIN, bool sync=true)
 Intersects the current clipping region of the view with the pixels outside of picture. More...
 
virtual void SetDrawingMode (drawing_mode mode)
 Sets the drawing mode of the view. More...
 
drawing_mode DrawingMode () const
 Return the current drawing_mode. More...
 
void SetBlendingMode (source_alpha srcAlpha, alpha_function alphaFunc)
 Set the blending mode which controls how transparency is used. More...
 
void GetBlendingMode (source_alpha *srcAlpha, alpha_function *alphaFunc) const
 Fill out srcAlpha and alphaFunc with the alpha mode and alpha function of the view. More...
 
virtual void SetPenSize (float size)
 Set the pen size to size. More...
 
float PenSize () const
 Return the current pen size. More...
 
bool HasDefaultColors () const
 Tests if the view has any colors set. More...
 
bool HasSystemColors () const
 Tests if the view is using system "panel" colors. B_PANEL_BACKGROUND_COLOR for ViewUIColor() B_PANEL_BACKGROUND_COLOR for LowUIColor() B_PANEL_TEXT_COLOR for HighUIColor() More...
 
void AdoptParentColors ()
 Attempts to use the colors of any parent view. Will adopt view, low, and high colors. Should be called in AttachedToWindow() or AllAttached(). More...
 
void AdoptSystemColors ()
 Instructs view to use standard system "panel" colors. B_PANEL_BACKGROUND_COLOR for ViewUIColor() B_PANEL_BACKGROUND_COLOR for LowUIColor() B_PANEL_TEXT_COLOR for HighUIColor() More...
 
void AdoptViewColors (BView *view)
 Attempts to use the colors of a given view. Will adopt view, low, and high colors. More...
 
virtual void SetViewColor (rgb_color color)
 Set the view color of the view. More...
 
void SetViewColor (uchar red, uchar green, uchar blue, uchar alpha=255)
 Set the view color of the view. More...
 
rgb_color ViewColor () const
 Return the current view color. More...
 
void SetViewUIColor (color_which which, float tint=B_NO_TINT)
 Set the view color of the view to a system constant. The color will update live with user changes. More...
 
color_which ViewUIColor (float *tint=NULL) const
 Return the current view color constant being used. More...
 
virtual void SetHighColor (rgb_color color)
 Set the high color of the view. More...
 
void SetHighColor (uchar red, uchar green, uchar blue, uchar alpha=255)
 Set the high color of the view. More...
 
rgb_color HighColor () const
 Return the current high color. More...
 
void SetHighUIColor (color_which which, float tint=B_NO_TINT)
 Set the high color of the view to a system constant. The color will update live with user changes. More...
 
color_which HighUIColor (float *tint=NULL) const
 Return the current high color constant being used. More...
 
virtual void SetLowColor (rgb_color color)
 Set the low color of the view. More...
 
void SetLowColor (uchar red, uchar green, uchar blue, uchar alpha=255)
 Set the low color of the view. More...
 
rgb_color LowColor () const
 Return the current low color. More...
 
void SetLowUIColor (color_which which, float tint=B_NO_TINT)
 Set the low color of the view to a system constant. The color will update live with user changes. More...
 
color_which LowUIColor (float *tint=NULL) const
 Return the current low color constant being used. More...
 
void SetLineMode (cap_mode lineCap, join_mode lineJoin, float miterLimit=B_DEFAULT_MITER_LIMIT)
 Set line mode to use PostScript-style line cap and join modes. More...
 
join_mode LineJoinMode () const
 Returns the current line join mode. More...
 
cap_mode LineCapMode () const
 Returns the current line cap mode. More...
 
float LineMiterLimit () const
 Returns the miter limit used for B_MITER_JOIN join mode. More...
 
void SetOrigin (BPoint where)
 Sets the origin in the view's coordinate system. More...
 
void SetOrigin (float x, float y)
 Sets the origin in the view's coordinate system. More...
 
BPoint Origin () const
 Returns the origin point in the view's coordinate system. More...
 
void PushState ()
 Saves the drawing state to the stack. More...
 
void PopState ()
 Restores the drawing state from the stack. More...
 
void MovePenTo (BPoint pt)
 Move the pen to point in the view's coordinate system. More...
 
void MovePenTo (float x, float y)
 Move the pen to the point specified by x and y in the view's coordinate system. More...
 
void MovePenBy (float x, float y)
 Move the pen by x pixels horizontally and y pixels vertically. More...
 
BPoint PenLocation () const
 Return the current pen location as a BPoint object. More...
 
void GetFont (BFont *font) const
 Fill out font with the font set to the view. More...
 
void TruncateString (BString *in_out, uint32 mode, float width) const
 Truncate string with truncation mode mode so that it is no wider than width set in the view's font. More...
 
float StringWidth (const char *string) const
 Return the width of string set in the font of the view. More...
 
float StringWidth (const char *string, int32 length) const
 Return the width of string set in the font of the view up to length characters. More...
 
void GetStringWidths (char *stringArray[], int32 lengthArray[], int32 numStrings, float widthArray[]) const
 Fill out widths of the strings in stringArray set in the font of the view into widthArray. More...
 
void SetFontSize (float size)
 Set the size of the view's font to size. More...
 
void ForceFontAliasing (bool enable)
 Turn anti-aliasing on and off when printing. More...
 
void GetFontHeight (font_height *height) const
 Fill out the font_height struct with the view font. More...
 
void SetScale (float scale) const
 Sets the scale of the coordinate system the view uses for drawing. More...
 
float Scale () const
 Return the current drawing scale. More...
 
void SetViewBitmap (const BBitmap *bitmap, BRect srcRect, BRect dstRect, uint32 followFlags=B_FOLLOW_LEFT_TOP, uint32 options=B_TILE_BITMAP)
 Sets the background bitmap of the view. More...
 
void SetViewBitmap (const BBitmap *bitmap, uint32 followFlags=B_FOLLOW_LEFT_TOP, uint32 options=B_TILE_BITMAP)
 Sets the background bitmap of the view. More...
 
void ClearViewBitmap ()
 Clears the background bitmap of the view if it has one. More...
 
status_t SetViewOverlay (const BBitmap *overlay, BRect srcRect, BRect dstRect, rgb_color *colorKey, uint32 followFlags=B_FOLLOW_LEFT_TOP, uint32 options=0)
 Sets the overlay bitmap of the view. More...
 
status_t SetViewOverlay (const BBitmap *overlay, rgb_color *colorKey, uint32 followFlags=B_FOLLOW_LEFT_TOP, uint32 options=0)
 Sets the overlay bitmap of the view. More...
 
void ClearViewOverlay ()
 Clears the overlay bitmap of the view if it has one. More...
 
void StrokeLine (BPoint toPoint, ::pattern pattern=B_SOLID_HIGH)
 Stroke a line from the current pen location to the point toPoint. More...
 
void StrokeLine (BPoint start, BPoint end, ::pattern pattern=B_SOLID_HIGH)
 Stroke a line from point start to point end. More...
 
void BeginLineArray (int32 count)
 Begin a line array of up to count lines. More...
 
void AddLine (BPoint start, BPoint end, rgb_color color)
 Add a line to the line array drawn from start to end. More...
 
void EndLineArray ()
 End the line array drawing the lines. More...
 
void StrokePolygon (const BPolygon *polygon, bool closed=true, ::pattern pattern=B_SOLID_HIGH)
 Stroke a polygon shape. More...
 
void StrokePolygon (const BPoint *pointArray, int32 numPoints, bool closed=true, ::pattern pattern=B_SOLID_HIGH)
 Stroke a polygon shape made up of points specified by pointArray. More...
 
void StrokePolygon (const BPoint *pointArray, int32 numPoints, BRect bounds, bool closed=true, ::pattern pattern=B_SOLID_HIGH)
 Stroke a polygon shape made up of points specified by pointArray inscribed by bounds. More...
 
void FillPolygon (const BPolygon *polygon, ::pattern pattern=B_SOLID_HIGH)
 Fill a polygon shape. More...
 
void FillPolygon (const BPoint *pointArray, int32 numPoints, ::pattern pattern=B_SOLID_HIGH)
 Fill a polygon shape made up of points specified by pointArray. More...
 
void FillPolygon (const BPoint *pointArray, int32 numPoints, BRect bounds, ::pattern pattern=B_SOLID_HIGH)
 Fill a polygon shape made up of points specified by pointArray inscribed by bounds. More...
 
void FillPolygon (const BPolygon *polygon, const BGradient &gradient)
 Fill a polygon shape with the specified gradient pattern. More...
 
void FillPolygon (const BPoint *pointArray, int32 numPoints, const BGradient &gradient)
 Fill a polygon shape made up of points specified by pointArray with the specified gradient pattern. More...
 
void FillPolygon (const BPoint *pointArray, int32 numPoints, BRect bounds, const BGradient &gradient)
 Fill a polygon shape made up of points specified by pointArray inscribed by bounds with the specified gradient pattern. More...
 
void StrokeTriangle (BPoint point1, BPoint point2, BPoint point3, BRect bounds, ::pattern pattern=B_SOLID_HIGH)
 Stroke the triangle specified by points point1, point2, and point3 and enclosed by bounds. More...
 
void StrokeTriangle (BPoint point1, BPoint point2, BPoint point3, ::pattern pattern=B_SOLID_HIGH)
 Stroke the triangle specified by points point1, point2, and point3. More...
 
void FillTriangle (BPoint point1, BPoint point2, BPoint point3, ::pattern pattern=B_SOLID_HIGH)
 Fill the triangle specified by points point1, point2, and point3. More...
 
void FillTriangle (BPoint point1, BPoint point2, BPoint point3, BRect bounds, ::pattern pattern=B_SOLID_HIGH)
 Fill the triangle specified by points point1, point2, and point3 and enclosed by bounds. More...
 
void FillTriangle (BPoint point1, BPoint point2, BPoint point3, const BGradient &gradient)
 Fill the triangle specified by points point1, point2, and point3 with the specified gradient pattern. More...
 
void FillTriangle (BPoint point1, BPoint point2, BPoint point3, BRect bounds, const BGradient &gradient)
 Fill the triangle specified by points point1, point2, and point3 and enclosed by bounds with the specified gradient pattern. More...
 
void StrokeRect (BRect rect, ::pattern pattern=B_SOLID_HIGH)
 Stroke the rectangle specified by rect. More...
 
void FillRect (BRect rect, ::pattern pattern=B_SOLID_HIGH)
 Fill the rectangle specified by rect. More...
 
void FillRect (BRect rect, const BGradient &gradient)
 Fill the rectangle specified by rect with the specified gradient pattern. More...
 
void FillRegion (BRegion *rectegion, ::pattern pattern=B_SOLID_HIGH)
 Fill region. More...
 
void FillRegion (BRegion *rectegion, const BGradient &gradient)
 Fill region with the specified gradient pattern. More...
 
void InvertRect (BRect rect)
 Inverts the colors within rect. More...
 
void StrokeRoundRect (BRect rect, float xRadius, float yRadius, ::pattern pattern=B_SOLID_HIGH)
 Stroke the rounded rectangle with horizontal radius xRadius and vertical radius yRadius. More...
 
void FillRoundRect (BRect rect, float xRadius, float yRadius, ::pattern pattern=B_SOLID_HIGH)
 Fill the rounded rectangle with horizontal radius xRadius and vertical radius yRadius. More...
 
void FillRoundRect (BRect rect, float xRadius, float yRadius, const BGradient &gradient)
 Fill the rounded rectangle with horizontal radius xRadius and vertical radius yRadius with the specified gradient pattern. More...
 
void StrokeEllipse (BPoint center, float xRadius, float yRadius, ::pattern pattern=B_SOLID_HIGH)
 Stroke the outline of an ellipse starting at center with a horizontal radius of xRadius and a vertical radius of yRadius. More...
 
void StrokeEllipse (BRect rect, ::pattern pattern=B_SOLID_HIGH)
 Stroke the outline of an ellipse inscribed within rect. More...
 
void FillEllipse (BPoint center, float xRadius, float yRadius, ::pattern pattern=B_SOLID_HIGH)
 Fill an ellipse starting at center with a horizontal radius of xRadius and a vertical radius of yRadius. More...
 
void FillEllipse (BRect rect, ::pattern pattern=B_SOLID_HIGH)
 Fill an ellipse inscribed within rect. More...
 
void FillEllipse (BPoint center, float xRadius, float yRadius, const BGradient &gradient)
 Fill an ellipse with the specified gradient pattern starting at center with a horizontal radius of xRadius and a vertical radius of yRadius. More...
 
void FillEllipse (BRect rect, const BGradient &gradient)
 Fill an ellipse with the specified gradient pattern inscribed within rect. More...
 
void StrokeArc (BPoint center, float xRadius, float yRadius, float startAngle, float arcAngle, ::pattern pattern=B_SOLID_HIGH)
 Stroke the outline of an arc starting at center with a horizontal radius of xRadius and a vertical radius of yRadius starting at startAngle and drawing arcAngle degrees. More...
 
void StrokeArc (BRect rect, float startAngle, float arcAngle, ::pattern pattern=B_SOLID_HIGH)
 Stroke the outline of an arc inscribed within rect starting at startAngle and drawing arcAngle degrees. More...
 
void FillArc (BPoint center, float xRadius, float yRadius, float startAngle, float arcAngle, ::pattern pattern=B_SOLID_HIGH)
 Fill an arc starting at center with a horizontal radius of xRadius and a vertical radius of yRadius starting at startAngle and drawing arcAngle degrees. More...
 
void FillArc (BRect rect, float startAngle, float arcAngle, ::pattern pattern=B_SOLID_HIGH)
 Fill an arc inscribed within rect starting at startAngle and drawing arcAngle degrees. More...
 
void FillArc (BPoint center, float xRadius, float yRadius, float startAngle, float arcAngle, const BGradient &gradient)
 Fill an arc with the specified gradient pattern starting at center with a horizontal radius of xRadius and a vertical radius of yRadius starting at startAngle and drawing arcAngle degrees. More...
 
void FillArc (BRect rect, float startAngle, float arcAngle, const BGradient &gradient)
 Fill an arc with the specified gradient pattern inscribed within rect starting at startAngle and drawing arcAngle degrees. More...
 
void StrokeBezier (BPoint *controlPoints, ::pattern pattern=B_SOLID_HIGH)
 Stroke a bezier curve. More...
 
void FillBezier (BPoint *controlPoints, ::pattern pattern=B_SOLID_HIGH)
 Fill a bezier curve. More...
 
void FillBezier (BPoint *controlPoints, const BGradient &gradient)
 Fill a bezier curve. More...
 
void StrokeShape (BShape *shape, ::pattern pattern=B_SOLID_HIGH)
 Stroke shape. More...
 
void FillShape (BShape *shape, ::pattern pattern=B_SOLID_HIGH)
 Fill shape. More...
 
void FillShape (BShape *shape, const BGradient &gradient)
 Fill shape with the specified gradient pattern. More...
 
void CopyBits (BRect src, BRect dst)
 Copy the bits from the src rectangle to the dst rectangle in the view's coordinate system. More...
 
void DrawBitmapAsync (const BBitmap *aBitmap, BRect bitmapRect, BRect viewRect, uint32 options)
 Draws bitmap on the view within viewRect asynchronously. More...
 
void DrawBitmapAsync (const BBitmap *aBitmap, BRect bitmapRect, BRect viewRect)
 Draws bitmap on the view within viewRect asynchronously. More...
 
void DrawBitmapAsync (const BBitmap *aBitmap, BRect viewRect)
 Draws bitmap on the view within viewRect asynchronously. More...
 
void DrawBitmapAsync (const BBitmap *aBitmap, BPoint where)
 Draws bitmap on the view offset by where asynchronously. More...
 
void DrawBitmapAsync (const BBitmap *aBitmap)
 Draws bitmap on the view asynchronously. More...
 
void DrawBitmap (const BBitmap *aBitmap, BRect bitmapRect, BRect viewRect, uint32 options)
 brief Draws bitmap on the view within viewRect. More...
 
void DrawBitmap (const BBitmap *aBitmap, BRect bitmapRect, BRect viewRect)
 Draws bitmap on the view within viewRect. More...
 
void DrawBitmap (const BBitmap *aBitmap, BRect viewRect)
 Draws bitmap on the view within viewRect. More...
 
void DrawBitmap (const BBitmap *aBitmap, BPoint where)
 Draws bitmap on the view offset by where. More...
 
void DrawBitmap (const BBitmap *aBitmap)
 Draws bitmap on the view. More...
 
void DrawChar (char aChar)
 Draws character c onto to the view at the current pen position. More...
 
void DrawChar (char aChar, BPoint location)
 Draws character c at the specified location in the view. More...
 
void DrawString (const char *string, escapement_delta *delta=NULL)
 Draw string onto the view at the current pen position. More...
 
void DrawString (const char *string, BPoint location, escapement_delta *delta=NULL)
 Draw string onto the view at the specified location in the view. More...
 
void DrawString (const char *string, int32 length, escapement_delta *delta=NULL)
 Draw string up to length characters onto the view at the current pen position. More...
 
void DrawString (const char *string, int32 length, BPoint location, escapement_delta *delta=0L)
 Draw string up to length characters onto the view at the specified location in the view. More...
 
void DrawString (const char *string, const BPoint *locations, int32 locationCount)
 Draw string locationCount times at the specified locations. More...
 
void DrawString (const char *string, int32 length, const BPoint *locations, int32 locationCount)
 Draw string up to length characters locationCount times at the specified locations. More...
 
void Invalidate (BRect invalRect)
 Sends a message to App Server to redraw the portion of the view specified by invalRect. More...
 
void Invalidate (const BRegion *invalRegion)
 Sends a message to App Server to redraw the portion of the view specified by region. More...
 
void Invalidate ()
 Sends a message to App Server to redraw the view. More...
 
void DelayedInvalidate (bigtime_t delay)
 Sends a message to App Server to redraw the entire view after a certain, minimum, delay. Repeated calls to this method may be merged, but the view is guaranteed to be redrawn after the delay given in the first call of this method. More...
 
void DelayedInvalidate (bigtime_t delay, BRect invalRect)
 Sends a message to App Server to redraw the portion of the view specified by invalRect after a certain, minimum, delay. Repeated calls to this method may be merged, but the invalidated rect is guaranteed to be redrawn after the minimum delay given by the first call of this method. More...
 
void SetDiskMode (char *filename, long offset)
 Unimplemented. More...
 
void BeginPicture (BPicture *a_picture)
 Begins sending drawing instructions to picture. More...
 
void AppendToPicture (BPicture *a_picture)
 Appends drawing instructions to picture without clearing it first. More...
 
BPictureEndPicture ()
 Ends the drawing instruction recording session and returns the BPicture object passed to BeginPicture() or AppendToPicture(). More...
 
void DrawPicture (const BPicture *a_picture)
 Draws the picture at the view's current pen position. More...
 
void DrawPicture (const BPicture *a_picture, BPoint where)
 Draws the picture at the location in the view specified by where. More...
 
void DrawPicture (const char *filename, long offset, BPoint where)
 Draws the picture from the file specified by filename offset by offset bytes at the location in the view specified by where. More...
 
void DrawPictureAsync (const BPicture *a_picture)
 Draws the picture at the view's current pen position. More...
 
void DrawPictureAsync (const BPicture *a_picture, BPoint where)
 Draws the picture at the location in the view specified by where. More...
 
void DrawPictureAsync (const char *filename, long offset, BPoint where)
 Draws the picture from the file specified by filename offset by offset bytes at the location in the view specified by where. More...
 
void MoveBy (float dh, float dv)
 Moves the view deltaX pixels horizontally and deltaY pixels vertically in the parent view's coordinate system. More...
 
void MoveTo (BPoint where)
 Move the view to the location specified by where in the parent view's coordinate system. More...
 
void MoveTo (float x, float y)
 Move the view to the coordinates specified by x in the horizontal dimension and y in the vertical dimension in the parent view's coordinate system. More...
 
void ResizeBy (float dh, float dv)
 Resize the view by deltaWidth horizontally and deltaHeight vertically without moving the top left corner of the view. More...
 
void ResizeTo (float width, float height)
 Resize the view to the specified width and height. More...
 
void ResizeTo (BSize size)
 Resize the view to the dimension specified by size. More...
 
virtual status_t AllUnarchived (const BMessage *archive)
 Hook method called when all views have been unarchived. More...
 
virtual status_t AllArchived (BMessage *archive) const
 Hook method called when all views have been archived. More...
 
virtual void WindowActivated (bool active)
 Hook method called when the attached window is activated or deactivated. More...
 
virtual void KeyDown (const char *bytes, int32 numBytes)
 Hook method called when a keyboard key is pressed. More...
 
virtual void KeyUp (const char *bytes, int32 numBytes)
 Hook method called when a keyboard key is released. More...
 
virtual void Pulse ()
 Hook method called when the view receives a B_PULSE message. More...
 
virtual void TargetedByScrollView (BScrollView *scrollView)
 Hook method called when the view becomes the target of scrollView. More...
 
virtual void DrawAfterChildren (BRect updateRect)
 Perform any drawing that needs to be done after child view have already been drawn. More...
 
void BeginRectTracking (BRect startRect, uint32 style=B_TRACK_WHOLE_RECT)
 Displays an outline rectangle on the view and initiates tracking. More...
 
void EndRectTracking ()
 Ends tracking removing the outline rectangle from the view. More...
 
void GetMouse (BPoint *location, uint32 *buttons, bool checkMessageQueue=true)
 Fills out the cursor location and the current state of the mouse buttons. More...
 
void DragMessage (BMessage *message, BRect dragRect, BHandler *replyTo=NULL)
 Initiates a drag-and-drop session. More...
 
void DragMessage (BMessage *message, BBitmap *bitmap, BPoint offset, BHandler *replyTo=NULL)
 Initiates a drag-and-drop session of an image. More...
 
void DragMessage (BMessage *message, BBitmap *bitmap, drawing_mode dragMode, BPoint offset, BHandler *replyTo=NULL)
 Initiates a drag-and-drop session of an image with drawing_mode set by dragMode. More...
 
status_t SetEventMask (uint32 mask, uint32 options=0)
 Sets whether or not the view can accept mouse and keyboard events when not in focus. More...
 
uint32 EventMask ()
 Returns the current event mask. More...
 
status_t SetMouseEventMask (uint32 mask, uint32 options=0)
 Sets whether or not the view can accept mouse and keyboard events when not in focus from within MouseDown() until the following MouseUp() event. More...
 
void ScrollBy (float dh, float dv)
 Scroll the view by deltaX horizontally and deltaY vertically. More...
 
virtual void ScrollTo (BPoint where)
 Scroll the view to the point specified by where. More...
 
BScrollBarScrollBar (orientation direction) const
 Returns the BScrollBar object that has the BView set as its target. More...
 
void SetExplicitMinSize (BSize size)
 Set this view's min size, to be used by MinSize(). More...
 
void SetExplicitMaxSize (BSize size)
 Set this view's max size, to be used by MaxSize(). More...
 
void SetExplicitPreferredSize (BSize size)
 Set this view's preferred size, to be used by PreferredSize(). More...
 
void SetExplicitAlignment (BAlignment alignment)
 Set this view's alignment, to be used by Alignment(). More...
 
void InvalidateLayout (bool descendants=false)
 Invalidate layout. More...
 
virtual void SetLayout (BLayout *layout)
 Sets the layout of the view. More...
 
BLayoutGetLayout () const
 Get the layout of the view. More...
 
void EnableLayoutInvalidation ()
 Enable layout invalidation. More...
 
void DisableLayoutInvalidation ()
 Disable layout invalidation. More...
 
bool IsLayoutInvalidationDisabled ()
 Returns whether or not layout invalidation is disabled. More...
 
bool IsLayoutValid () const
 Returns whether or not the layout is valid. More...
 
void ResetLayoutInvalidation ()
 Service call for BView derived classes re-enabling InvalidateLayout() notifications. More...
 
void Layout (bool force)
 Layout the view. More...
 
void Relayout ()
 Relayout the view. More...
 
void SetToolTip (const char *text)
 Set the tool tip of the view to text. More...
 
void SetToolTip (BToolTip *tip)
 Set the tool tip of the view to the tip object. More...
 
BToolTipToolTip () const
 Return the tool tip set to the view or NULL if not set. More...
 
void ShowToolTip (BToolTip *tip=NULL)
 Show the tool tip at the current mouse position. More...
 
void HideToolTip ()
 Hide the view's tool tip. More...
 
- Public Member Functions inherited from BHandler
 BHandler (const char *name=NULL)
 Construct a new handler with a name. More...
 
virtual ~BHandler ()
 Free the filters of this handler, as well as the list of observers. More...
 
 BHandler (BMessage *data)
 Construct a handler from an archived message. More...
 
BLooperLooper () const
 Return a pointer to the looper that this handler is associated with. More...
 
void SetName (const char *name)
 Set or change the name of this handler. More...
 
const char * Name () const
 Return the name of this handler. More...
 
virtual void SetNextHandler (BHandler *handler)
 Set the next handler in the chain that the message is passed on to if this handler cannot process it. More...
 
BHandlerNextHandler () const
 Return the next hander in the chain to which the message is passed on. More...
 
virtual void AddFilter (BMessageFilter *filter)
 Add filter as a prerequisite to this handler. More...
 
virtual bool RemoveFilter (BMessageFilter *filter)
 Remove filter from the filter list. More...
 
virtual void SetFilterList (BList *filters)
 Set the internal list of filters to filters. More...
 
BListFilterList ()
 Return a pointer to the list of filters. More...
 
bool LockLooper ()
 Lock the looper associated with this handler. More...
 
status_t LockLooperWithTimeout (bigtime_t timeout)
 Lock the looper associated with this handler, with a time out value. More...
 
void UnlockLooper ()
 Unlock the looper. More...
 
status_t StartWatching (BMessenger target, uint32 what)
 Subscribe this handler to watch a specific state change of a target. More...
 
status_t StartWatchingAll (BMessenger target)
 Subscribe this handler to watch a target for all events. More...
 
status_t StopWatching (BMessenger target, uint32 what)
 Unsubscribe this handler from watching a specific state. More...
 
status_t StopWatchingAll (BMessenger target)
 Unsubscribe this handler from watching all states. More...
 
status_t StartWatching (BHandler *observer, uint32 what)
 Subscribe an observer for a specific state change of this handler. More...
 
status_t StartWatchingAll (BHandler *observer)
 Subscribe an observer for a all state changes. More...
 
status_t StopWatching (BHandler *observer, uint32 what)
 Unsubscribe an observer from watching a specific state. More...
 
status_t StopWatchingAll (BHandler *observer)
 Unsubscribe an observer from watching all states. More...
 
virtual void SendNotices (uint32 what, const BMessage *notice=NULL)
 Emit a state change to the observers. More...
 
bool IsWatched () const
 Check if there are any observers watching this handler. More...
 
- Public Member Functions inherited from BArchivable
 BArchivable (BMessage *from)
 Constructor. Does important behind-the-scenes work in the unarchiving process. More...
 
 BArchivable ()
 Constructor. Does nothing. More...
 
virtual ~BArchivable ()
 Destructor. Does nothing. More...
 

Protected Member Functions

virtual void LayoutInvalidated (bool descendants=false)
 Hook method called when the layout is invalidated. More...
 
- Protected Member Functions inherited from BView
status_t ScrollWithMouseWheelDelta (BScrollBar *, float)
 Handle the scroll wheel changing over scrollbars. More...
 
virtual void DoLayout ()
 Layout view within the layout context. More...
 
virtual bool GetToolTipAt (BPoint point, BToolTip **_tip)
 Point _tip with the view's tool tip. More...
 

Archiving

virtual status_t Archive (BMessage *archive, bool deep=true) const
 Archives the the BStringView object into the archive message. More...
 
static BArchivableInstantiate (BMessage *archive)
 Creates a new BStringView object from an archive message. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BView
static BArchivableInstantiate (BMessage *archive)
 Creates a new BView object from the data message. More...
 
- Static Public Member Functions inherited from BHandler
static BArchivableInstantiate (BMessage *data)
 Static method to instantiate a handler from an archived message. More...
 
- Static Public Member Functions inherited from BArchivable
static BArchivableInstantiate (BMessage *archive)
 Static member to restore objects from messages. More...
 

Detailed Description

Draws a non-editable single-line text string, most commonly used as a label.

Since
BeOS R3

Constructor & Destructor Documentation

◆ BStringView() [1/3]

BStringView::BStringView ( BRect  frame,
const char *  name,
const char *  text,
uint32  resizingMode = B_FOLLOW_LEFT_TOP,
uint32  flags = B_WILL_DRAW 
)

Creates a new BStringView object which displays the non-editable text string in the plain system font (be_plain_font).

Parameters
frameThe frame rectangle to draw the string view into.
nameThe string view's name. Can be NULL.
textThe string view's label text. Can be NULL.
resizingModeSets the parameters by which the BStringView can be resized. See BView for more information on resizing options.
flagsThe flags mask sets what notifications the BStringView can receive. See BView for more information on flags. B_FULL_UPDATE_ON_RESIZE is always set.

In order to prevent the string from being truncated the frame rectangle must 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 left-aligned, call SetAlignment() to set a different horizontal alignment.

You may also change the font variety used by calling SetFont().

See also
SetAlignment()
SetFont()
Since
BeOS R3

◆ BStringView() [2/3]

BStringView::BStringView ( const char *  name,
const char *  text,
uint32  flags = B_WILL_DRAW 
)

Layout constructor.

Parameters
nameThe string view's name. Can be NULL.
textThe string view's label text. Can be NULL.
flagsThe flags mask sets what notifications the BStringView can receive. See BView for more information on flags. B_FULL_UPDATE_ON_RESIZE is always set.

The string is left-aligned by default. There are two ways to set the horizontal alignment of the string view. The preferred method is to call BLayoutItem::SetExplicitAlignment() or you may also call SetAlignment().

You may also change the font variety used by calling SetFont().

See also
BLayoutItem::SetExplicitAlignment()
SetAlignment()
SetFont()
Since
Haiku R1

◆ BStringView() [3/3]

BStringView::BStringView ( BMessage archive)

Archive constructor.

Warning
This method is usually not called directly. If you want to build a string view from an archive message you should call Instantiate() instead which can handle errors properly.
Parameters
archiveThe message archive to construct the string view from.
Since
BeOS R3

◆ ~BStringView()

BStringView::~BStringView ( )
virtual

Destructor method, frees the memory used by the string view.

Since
BeOS R3

Member Function Documentation

◆ Alignment()

alignment BStringView::Alignment ( ) const

Returns the currently set text alignment flag.

Returns
The current alignment flag.
See also
SetAlignment()
Since
BeOS R3

◆ AllAttached()

void BStringView::AllAttached ( )
virtual

Similar to AttachedToWindow() but this method is triggered after all child views have already been attached to a window.

Since
BeOS R3

Reimplemented from BView.

◆ AllDetached()

void BStringView::AllDetached ( )
virtual

Similar to AttachedToWindow() but this method is triggered after all child views have already been detached from a window.

Since
BeOS R3

Reimplemented from BView.

◆ Archive()

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

Archives the the BStringView object into the archive message.

Parameters
archiveA pointer to the BMessage to archive the object into.
deepThis parameter has no effect for this class.
Returns
A status code, B_OK if everything went well or an error code otherwise.
Return values
B_OKThe object was archived successfully.
B_NO_MEMORYRan out of memory while archiving the object.
Since
BeOS R3

Reimplemented from BView.

◆ AttachedToWindow()

void BStringView::AttachedToWindow ( )
virtual

Hook method called when the BStringView is attached to a window.

The view color is set to either the parent's view color or B_TRANSPARENT_COLOR if the string view isn't attached to a view.

See also
BView::AttachedToWindow()
Since
BeOS R3

Reimplemented from BView.

◆ DetachedFromWindow()

void BStringView::DetachedFromWindow ( )
virtual

Hook method called when the BStringView is detached from a window.

Since
BeOS R3

Reimplemented from BView.

◆ Draw()

void BStringView::Draw ( BRect  updateRect)
virtual

Draws the area of the view that intersects updateRect.

Remarks
This is an hook method called by the Interface Kit, you don't have to call it yourself. If you need to forcefully redraw the view consider calling Invalidate() instead.
Parameters
updateRectThe rectangular area to be drawn.
Since
BeOS R3
See also
BView::Draw()

Reimplemented from BView.

◆ FrameMoved()

void BStringView::FrameMoved ( BPoint  newPosition)
virtual

Hook method called when the string view is moved.

Parameters
newPositionThe point of the top left corner of the frame that the view has been moved to.
Since
BeOS R3

Reimplemented from BView.

◆ FrameResized()

void BStringView::FrameResized ( float  newWidth,
float  newHeight 
)
virtual

Hook method called when the string view is resized.

Parameters
newWidthThe new width of the view.
newHeightThe new height of the view.
Since
BeOS R3

Reimplemented from BView.

◆ GetPreferredSize()

void BStringView::GetPreferredSize ( float *  _width,
float *  _height 
)
virtual

Fills out the preferred width and height of the string view into the _width and _height parameters respectively.

Derived classes should override this method to set the preferred size of object.

Remarks
Either the _width or _height parameter may be set to NULL if you only want to get the other one.
Parameters
[out]_widthPointer to a float to store the width of the view.
[out]_heightPointer to a float to store the height of the view.
Since
BeOS R3

Reimplemented from BView.

◆ GetSupportedSuites()

status_t BStringView::GetSupportedSuites ( BMessage message)
virtual

Reports the suites of messages and specifiers that derived classes understand.

Since
BeOS R3

Reimplemented from BView.

◆ Instantiate()

BArchivable * BStringView::Instantiate ( BMessage archive)
static

Creates a new BStringView object from an archive message.

The string view's text, and alignment can be set using this method.

  • The "_text" property is a B_STRING_TYPE containing the text of the string view.
  • The "_align" property is a B_INT32_TYPE containing the string view's alignment flag. This should be casted to an alignment type. Choices are:
    • B_ALIGN_LEFT
    • B_ALIGN_RIGHT
    • B_ALIGN_CENTER
Returns
A newly created BStringView object or NULL if the message doesn't contain an archived BStringView.
Since
BeOS R3

◆ LayoutAlignment()

BAlignment BStringView::LayoutAlignment ( )
virtual

Returns the alignment used by this view as part of a BLayout.

Returns
The alignment used by this view as a BAlignment.
Since
Haiku R1

Reimplemented from BView.

◆ LayoutInvalidated()

void BStringView::LayoutInvalidated ( bool  descendants = false)
protectedvirtual

Hook method called when the layout is invalidated.

The default implementation invalidates the cached preferred size.

Parameters
descendantsWhether or not child views have also been invalidated.
Since
Haiku R1

Reimplemented from BView.

◆ MakeFocus()

void BStringView::MakeFocus ( bool  focus = true)
virtual

Makes the string view the current focus view of the window or gives up being the window's focus view.

The focus view handles selections and KeyDown events when the the attached window is active. There can be only one focus view at a time per window.

When called with focus set to true this method first calls MakeFocus() on the previously focused view with focus set to false.

The focus doesn't automatically change when MouseDown() is called so calling MakeFocus() is the only way to make a view the focus view of a window. Classes derived from BView that can display the current selection, or that can accept pasted data should call MakeFocus() in their MouseDown() method to update the focus view of the window on click.

If the view isn't attached to a window this method has no effect.

Parameters
focustrue to set focus, false to remove it.
Since
BeOS R3

Reimplemented from BView.

◆ MaxSize()

BSize BStringView::MaxSize ( )
virtual

Returns the string view's maximum size.

Remarks
This is only meaningful if the view is part of a BLayout.
Returns
The maximum size of the view as a BSize.
See also
BAbstractLayout::MaxSize()
Since
Haiku R1

Reimplemented from BView.

◆ MessageReceived()

void BStringView::MessageReceived ( BMessage message)
virtual

Handle message received by the associated looper.

Parameters
messageThe message received by the associated looper.
See also
BHandler::MessageReceived()
Since
BeOS R3

Reimplemented from BView.

◆ MinSize()

BSize BStringView::MinSize ( )
virtual

Returns the string view's minimum size.

Remarks
This is only meaningful if the view is part of a BLayout.
Returns
The minimum size of the view as a BSize.
See also
BAbstractLayout::MinSize()
Since
Haiku R1

Reimplemented from BView.

◆ MouseDown()

void BStringView::MouseDown ( BPoint  where)
virtual

Hook method called when a mouse button is pressed.

Parameters
whereThe point on the screen where to mouse pointer is when the mouse button is pressed.
Since
BeOS R3

Reimplemented from BView.

◆ MouseMoved()

void BStringView::MouseMoved ( BPoint  where,
uint32  code,
const BMessage dragMessage 
)
virtual

Hook method called when the mouse is moved.

Parameters
whereThe new location of the mouse in the view's coordinate system.
codeOne of the following:
  • B_ENTERED_VIEW The cursor has just entered the view.
  • B_INSIDE_VIEW The cursor is inside the view.
  • B_EXITED_VIEW The cursor has left the view's bounds. This only gets sent if the scope of the mouse events that the view can receive has been expanded by SetEventMask() or SetMouseEventMask().
  • B_OUTSIDE_VIEW The cursor is outside the view. This only gets sent if the scope of the mouse events that the view can receive has been expanded by SetEventMask() or SetMouseEventMask().
dragMessageIf a drag-and-drop operation is taking place this is a pointer to a BMessage that holds the drag information, otherwise the pointer is NULL.
See also
SetEventMask(), SetMouseEventMask()
DragMessage()
Since
BeOS R3

Reimplemented from BView.

◆ MouseUp()

void BStringView::MouseUp ( BPoint  where)
virtual

Hook method called when a mouse button is released.

Parameters
whereThe point on the screen where to mouse pointer is when the mouse button is released.
Since
BeOS R3

Reimplemented from BView.

◆ PreferredSize()

BSize BStringView::PreferredSize ( )
virtual

Returns the string view's preferred size.

Remarks
This is only meaningful if the view is part of a BLayout.
Returns
The preferred size of the view as a BSize.
See also
BAbstractLayout::PreferredSize()
Since
Haiku R1

Reimplemented from BView.

◆ ResizeToPreferred()

void BStringView::ResizeToPreferred ( )
virtual

Resize the string view to its preferred size.

Warning
It is not recommended to use this method for views that are part of a BLayout.
Since
BeOS R3

Reimplemented from BView.

◆ ResolveSpecifier()

BHandler * BStringView::ResolveSpecifier ( BMessage message,
int32  index,
BMessage specifier,
int32  what,
const char *  property 
)
virtual

Determine the proper handler for a scripting message.

Parameters
messageThe scripting message to determine the handler.
indexThe index of the specifier.
specifierThe message which contains the specifier.
whatThe 'what' field of the specifier message.
propertyThe name of the target property.
Returns
A pointer to the proper BHandler for the given scripting message.
Since
BeOS R3

Reimplemented from BView.

◆ SetAlignment()

void BStringView::SetAlignment ( alignment  flag)

Sets the way text is aligned within the view's frame.

Choices are:

  • B_ALIGN_LEFT
  • B_ALIGN_RIGHT
  • B_ALIGN_CENTER
Remarks
For string views that are part of a BLayout consider using BLayoutItem::SetExplicitAlignment() instead.
Parameters
flagThe text alignment to set.
Since
BeOS R3

◆ SetFont()

void BStringView::SetFont ( const BFont font,
uint32  mask = B_FONT_ALL 
)
virtual

Sets the font of the string view to font with the font parameters set by mask.

Parameters
fontThe font to set the string view to.
maskA mask indicating which properties of font to set.
See also
BView::SetFont()
Since
Haiku R1

Reimplemented from BView.

◆ SetText()

void BStringView::SetText ( const char *  text)

Sets the text string displayed by the string view.

The text string is copied, BStringView does not take ownership of the memory referenced by the pointer so you should free it yourself afterwords. If a string has previously been set on the string view, the memory used by the old string is freed before setting the new string.

Parameters
textThe text string to set.
Since
BeOS R3

◆ Text()

const char * BStringView::Text ( ) const

Returns the text currently set on the string view.

Returns
The string view's text as a const char*.
Since
BeOS R3