nephele
/
haiku-website
0
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
haiku-website/static/legacy-docs/bebook/BStatusBar.html

144 lines
27 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Be Book - Classes And Methods - The Interface Kit</title><link rel="stylesheet" href="be_book.css" type="text/css" media="all" /><link rel="shortcut icon" type="image/vnd.microsoft.icon" href="./images/favicon.ico" /><!--[if IE]>
<link rel="stylesheet" type="text/css" href="be_book_ie.css" />
<![endif]--><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="keywords" content="Access, BeOS, BeBook, API" /><link rel="start" href="index.html" title="The Be Book" /><link rel="up" href="TheInterfaceKit.html" title="The Interface Kit" /><link rel="prev" href="BSlider.html" title="BSlider" /><link rel="next" href="BStringItem.html" title="BStringItem" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="BSlider.html" title="BSlider"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheInterfaceKit.html" title="The Interface Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="BStringItem.html" title="BStringItem"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="headerTR"><div id="navigpeople"><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div><div class="navigboxed" id="navigindex"><a accesskey="i" href="ClassIndex.html" title="Index">I</a></div><div class="navigboxed" id="naviglang" title="English">en</div></div><div id="headerTC">The Be Book - Classes And Methods - The Interface Kit</div></div><div id="headerB">Prev: <a href="BSlider.html">BSlider</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="BStringItem.html">BStringItem</a></div><hr /></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h2 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar"></a>BStatusBar</h2></div></div></div><a id="id1036591" class="indexterm"></a><div class="classheader"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td><table width="100%" border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Derived From:</td><td><a class="link" href="BView.html" title="BView"><code class="classname">BView</code></a></td></tr><tr><td>Mix-in Classes:</td><td>–</td></tr><tr><td>Declared In:</td><td><code class="filename">interface/StatusBar.h</code></td></tr><tr><td>Library:</td><td><code class="filename">libbe.so</code></td></tr><tr><td>Allocation:</td><td>–</td></tr></tbody></table></td><td>
<a class="link overview" href="BStatusBar_Overview.html" title="BStatusBar">Class Overview</a>
<div class="toc"><ul><li><span class="section"><a href="BStatusBar.html#BStatusBar_ConstructorDestructor">Constructor and Destructor</a></span></li><li><span class="section"><a href="BStatusBar.html#BStatusBar_HookFunctions">Hook Functions</a></span></li><li><span class="section"><a href="BStatusBar.html#BStatusBar_MemberFunctions">Member Functions</a></span></li><li><span class="section"><a href="BStatusBar.html#BStatusBar_StaticFunctions">Static Functions</a></span></li><li><span class="section"><a href="BStatusBar.html#BStatusBar_ArchivedFields">Archived Fields</a></span></li></ul></div>
</td></tr></tbody></table></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_ConstructorDestructor"></a>Constructor and Destructor</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Constructor"></a>BStatusBar()</h4></div></div></div><div class="synopsisgroup">
<code class="constructorsynopsis cpp"><span class="methodname">BStatusBar</span>(<span class="methodparam"><span class="type">BRect </span><span class="parameter">frame</span></span>,<br />           <span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">name</span></span>,<br />           <span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">label</span><span class="initializer"> = <span class="constant">NULL</span></span></span>,<br />           <span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">trailingLabel</span><span class="initializer"> = <span class="constant">NULL</span></span></span>);</code>
<code class="constructorsynopsis cpp"><span class="methodname">BStatusBar</span>(<span class="methodparam"><span class="type">BMessage* </span><span class="parameter">archive</span></span>);</code>
</div><p>
Initializes the <code class="classname">BStatusBar</code> with a
<code class="parameter">label</code> and a <code class="parameter">trailingLabel</code>,
which can both be <code class="constant">NULL</code>. The
<code class="parameter">frame</code> rectangle is used for its origin and width
only; when the <code class="classname">BStatusBar</code> is attached to a window,
it will be resized to a height that precisely accommodates its parts. The
<code class="parameter">name</code> argument is passed on to the <a class="link" href="BView.html" title="BView"><code class="classname">BView</code></a> constructor.
</p><p>
The object is given a <code class="constant">B_WILL_DRAW</code> flag
and a resizing mode that keeps it glued to the left and top sides of its parent.
</p><p>
The default font of the <code class="classname">BStatusBar</code> is the system plain font, and the
default color of the bar is blue (50, 150, 255). It's initial value is
0.0, the minimum, and its default maximum value is 100.0.
</p><p>
See also:
<a class="link" href="BStatusBar.html#BStatusBar_SetMaxValue" title="SetMaxValue(), MaxValue(), CurrentValue()"><code class="methodname">SetMaxValue()</code></a>,
<a class="link" href="BStatusBar.html#BStatusBar_SetBarColor" title="SetBarColor(), BarColor()"><code class="methodname">SetBarColor()</code></a>
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Destructor"></a>~BStatusBar()</h4></div></div></div><code class="destructorsynopsis cpp"><span class="modifier">virtual </span><span class="methodname">~BStatusBar</span>();</code><p>
Frees the labels and the text.
</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_HookFunctions"></a>Hook Functions</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_AttachedToWindow"></a>AttachedToWindow()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">AttachedToWindow</span>();</code><p>
Resizes the frame rectangle to accommodate the object's graphical parts.
The width isn't altered.
</p><p>
This function also sets the view and low colors of the <code class="classname">BStatusBar</code> to
match the background view color of its new parent.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Draw"></a>Draw()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">Draw</span>(<span class="methodparam"><span class="type">BRect </span><span class="parameter">updateRect</span></span>);</code><p>
Draws the bar, labels, and text.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_MessageReceived"></a>MessageReceived()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">MessageReceived</span>(<span class="methodparam"><span class="type"><a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a>* </span><span class="parameter">message</span></span>);</code><p>Responds to
<a class="link" href="TheInterfaceKit_MessageConstants.html#B_UPDATE_STATUS_BAR" title="B_UPDATE_STATUS_BAR"><code class="constant">B_UPDATE_STATUS_BAR</code></a> and
<a class="link" href="TheInterfaceKit_MessageConstants.html#B_RESET_STATUS_BAR" title="B_RESET_STATUS_BAR"><code class="constant">B_RESET_STATUS_BAR</code></a>
messages by calling the
<a class="link" href="BStatusBar.html#BStatusBar_Update" title="Update()"><code class="methodname">Update()</code></a> and
<a class="link" href="BStatusBar.html#BStatusBar_Reset" title="Reset()"><code class="methodname">Reset()</code></a> functions. Each message contains data
that can be passed as arguments to the functions.
</p><p>
See also:
<a class="link" href="BView.html#BView_MessageReceived" title="MessageReceived()"><code class="methodname">BView::MessageReceived()</code></a>,
"BStatusBar Messages" in the Message Protocols appendix
</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_MemberFunctions"></a>Member Functions</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Archive"></a>Archive()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="type">status_t </span><span class="methodname">Archive</span>(<span class="methodparam"><span class="type"><a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a>* </span><span class="parameter">archive</span></span>,<br />                         <span class="methodparam"><span class="type">bool </span><span class="parameter">deep</span><span class="initializer"> = <span class="constant">true</span></span></span>) <span class="modifier">const</span>;</code><p>
Calls the inherited version of <code class="methodname">Archive()</code>, then
adds the bar color, bar height, current value, and maximum value to the
<a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a> archive,
along with the current text, trailing text, label, and trailing label.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Label"></a><a id="BStatusBar_TrailingLabel"></a>
Label(), TrailingLabel()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">const </span><span class="type">char* </span><span class="methodname">Label</span>() <span class="modifier">const</span>;</code><code class="methodsynopsis cpp"><span class="modifier">const </span><span class="type">char* </span><span class="methodname">TrailingLabel</span>() <span class="modifier">const</span>;</code><p>
These functions return pointers to the object's label and trailing label.
The returned strings belong to the <code class="classname">BStatusBar</code> object and should not be
altered. They can be set only on construction or when all values are
reset.
</p><p>
See also:
<a class="link" href="BStatusBar.html#BStatusBar_Reset" title="Reset()"><code class="methodname">Reset()</code></a>
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Reset"></a>Reset()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">Reset</span>(<span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">label</span><span class="initializer"> = <span class="constant">NULL</span></span></span>,<br />                   <span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">trailingLabel</span><span class="initializer"> = <span class="constant">NULL</span></span></span>);</code><p>
Empties the status bar, sets its current value to 0.0 and its maximum
value to 100.0, deletes and erases the text and trailing text, and
replaces the label and trailing label with copies of the strings passed
as arguments. If either argument is <code class="constant">NULL</code>, the label or trailing label
will also be deleted and erased.
</p><p>
This gets the <code class="classname">BStatusBar</code> ready to be reused for another operation. For
example, if several large files are being downloaded, the <code class="classname">BStatusBar</code>
could be reset for each one.
</p><p>See also:
<a class="link" href="BStatusBar.html#BStatusBar_SetText" title="SetText(), SetTrailingText(), Text(), TrailingText()"><code class="methodname">SetText()</code></a>,
<a class="link" href="BStatusBar.html#BStatusBar_Update" title="Update()"><code class="methodname">Update()</code></a>,
the <a class="link" href="TheInterfaceKit_MessageConstants.html#B_RESET_STATUS_BAR" title="B_RESET_STATUS_BAR"><code class="constant">B_RESET_STATUS_BAR</code></a>
message constant.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_SetBarColor"></a><a id="BStatusBar_BarColor"></a>
SetBarColor(), BarColor()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">SetBarColor</span>(<span class="methodparam"><span class="type">rgb_color </span><span class="parameter">color</span></span>);</code><code class="methodsynopsis cpp"><span class="type">rgb_color </span><span class="methodname">BarColor</span>() <span class="modifier">const</span>;</code><p>
These functions set and return the color that fills the bar to show how
much of an operation has been completed. The default bar color is blue
(50, 150, 255).
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_SetBarHeight"></a><a id="BStatusBar_BarHeight"></a>
SetBarHeight(), BarHeight()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">SetBarHeight</span>(<span class="methodparam"><span class="type">float </span><span class="parameter">height</span></span>);</code><code class="methodsynopsis cpp"><span class="type">float </span><span class="methodname">BarHeight</span>() <span class="modifier">const</span>;</code><p>
These functions set and return the height of the bar itself, minus the
text and labels. The default height is 16.0 coordinate units. The frame
rectangle is adjusted to accommodate the new height, and the object is
redrawn.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_SetMaxValue"></a><a id="BStatusBar_MaxValue"></a>
<a id="BStatusBar_CurrentValue"></a>
SetMaxValue(), MaxValue(), CurrentValue()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">SetMaxValue</span>(<span class="methodparam"><span class="type">float </span><span class="parameter">max</span></span>);</code><code class="methodsynopsis cpp"><span class="type">float </span><span class="methodname">MaxValue</span>() <span class="modifier">const</span>;</code><code class="methodsynopsis cpp"><span class="type">float </span><span class="methodname">CurrentValue</span>() <span class="modifier">const</span>;</code><p>
<code class="methodname">SetMaxValue()</code> sets the maximum value of the <code class="classname">BStatusBar</code>, which by default
is 100.0. <code class="methodname">MaxValue()</code> returns the current maximum. The minimum value is
0.0 and cannot be changed.
</p><p>
<code class="methodname">CurrentValue()</code> returns the current value of the <code class="classname">BStatusBar</code>. The current
value is set by
<a class="link" href="BStatusBar.html#BStatusBar_Update" title="Update()"><code class="methodname">Update()</code></a> and reset to 0.0 by
<a class="link" href="BStatusBar.html#BStatusBar_Reset" title="Reset()"><code class="methodname">Reset()</code></a>.
</p><p>
The amount of "filling" in the status bar reflects the ratio
<code class="methodname">CurrentValue()</code>/<code class="methodname">MaxValue()</code>.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_SetText"></a><a id="BStatusBar_SetTrailingText"></a>
<a id="BStatusBar_Text"></a>
<a id="BStatusBar_TrailingText"></a>
SetText(), SetTrailingText(), Text(), TrailingText()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">SetText</span>(<span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">string</span></span>);</code><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">SetTrailingText</span>(<span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">string</span></span>);</code><code class="methodsynopsis cpp"><span class="modifier">const </span><span class="type">char* </span><span class="methodname">Text</span>() <span class="modifier">const</span>;</code><code class="methodsynopsis cpp"><span class="modifier">const </span><span class="type">char* </span><span class="methodname">TrailingText</span>() <span class="modifier">const</span>;</code><p>
These <code class="methodname">SetText()</code> and <code class="methodname">SetTrailingText()</code> functions erase the previous text
or trailing text and replace them with copies of the string argument.
string can be <code class="constant">NULL</code>. The view is automatically redrawn.
</p><p>
<code class="methodname">Text()</code> and <code class="methodname">TrailingText()</code> return pointers to the current text strings.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Update"></a>Update()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">virtual </span><span class="void">void </span><span class="methodname">Update</span>(<span class="methodparam"><span class="type">float </span><span class="parameter">delta</span></span>,<br />                    <span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">text</span><span class="initializer"> = <span class="constant">NULL</span></span></span>,<br />                    <span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">trailingText</span><span class="initializer"> = <span class="constant">NULL</span></span></span>);</code><p>
<code class="methodname">Update()</code> updates the <code class="classname">BStatusBar</code> by adding delta to its current value and
resetting its text and trailing text. Passing <code class="constant">NULL</code> for the <code class="parameter">text</code> or
<code class="parameter">trailingText</code> argument retains the existing string(s). The status bar is
automatically redrawn.
</p><p>See also:
<a class="link" href="BStatusBar.html#BStatusBar_Reset" title="Reset()"><code class="methodname">Reset()</code></a>,
the <a class="link" href="TheInterfaceKit_MessageConstants.html#B_UPDATE_STATUS_BAR" title="B_UPDATE_STATUS_BAR"><code class="constant">B_UPDATE_STATUS_BAR</code></a>
message constant.</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_StaticFunctions"></a>Static Functions</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_Instantiate"></a>Instantiate()</h4></div></div></div><code class="methodsynopsis cpp"><span class="modifier">static </span><span class="type"><a class="link" href="BArchivable.html" title="BArchivable"><code class="classname">BArchivable</code></a>* </span><span class="methodname">Instantiate</span>(<span class="methodparam"><span class="type"><a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a>* </span><span class="parameter">archive</span></span>);</code><p>
Returns a new <code class="classname">BStatusBar</code> object, allocated by new and created with the
version of the constructor that takes a
<a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a> archive. However, if the
archive doesn't contain data for an <code class="classname">BStatusBar</code> object, this function
returns <code class="constant">NULL</code>.
</p><p>
See also
<a class="link" href="BArchivable.html#BArchivable_Instantiate" title="Instantiate()"><code class="methodname">BArchivable::Instantiate()</code></a>,
<a class="link" href="TheSupportKit_Functions.html#instantiate_object" title="instantiate_object()"><code class="function">instantiate_object()</code></a>,
<a class="link" href="BStatusBar.html#BStatusBar_Archive" title="Archive()"><code class="methodname">Archive()</code></a>
</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BStatusBar_ArchivedFields"></a>Archived Fields</h3></div></div></div><p>
The <a class="link" href="BStatusBar.html#BStatusBar_Archive" title="Archive()"><code class="methodname">Archive()</code></a>
function adds the following fields to its
<a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a> argument:
</p><div class="informaltable"><table border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Field</th><th>Type code</th><th>Description</th></tr></thead><tbody><tr><td><code class="varname">_high</code></td><td><code class="constant">B_FLOAT_TYPE</code></td><td>Status bar height.</td></tr><tr><td><code class="varname">_bcolor</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>Status bar color.</td></tr><tr><td><code class="varname">_val</code></td><td><code class="constant">B_FLOAT_TYPE</code></td><td>Current value.</td></tr><tr><td><code class="varname">_max</code></td><td><code class="constant">B_FLOAT_TYPE</code></td><td>Maximum value.</td></tr><tr><td><code class="varname">_text</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>Status bar text.</td></tr><tr><td><code class="varname">_ttext</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>Trailing text.</td></tr><tr><td><code class="varname">_label</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>Status bar label.</td></tr><tr><td><code class="varname">_tlabel</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>Trailing text label.</td></tr></tbody></table></div><p>
Some of these fields may not be present if the setting they represent
isn't used, or is the default value. For example, if there is no trailing
text, the <code class="varname">_ttext</code> field won't be found in the archive.
</p></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="BSlider.html">BSlider</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="BStringItem.html">BStringItem</a> </div><div id="footerB"><div id="footerBL"><a href="BSlider.html" title="BSlider"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheInterfaceKit.html" title="The Interface Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="BStringItem.html" title="BStringItem"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="footerBR"><div><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div></div><div id="footerBC"><a href="http://www.access-company.com/home.html" title="ACCESS Co."><img alt="Access Company" src="./images/access_logo.png" /></a></div></div></div><div id="licenseFooter"><div id="licenseFooterBL"><a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="Creative Commons License"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-nc-nd/3.0/88x31.png" /></a></div><div id="licenseFooterBR"><a href="./LegalNotice.html">Legal Notice</a></div><div id="licenseFooterBC"><span id="licenseText">This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative
Commons Attribution-Non commercial-No Derivative Works 3.0 License</a>.</span></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink