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

200 lines
58 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.

<?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="TheInterfaceKit_GeneralConstants.html" title="General Constants" /><link rel="next" href="TheInterfaceKit_DefinedTypes.html" title="Defined Types" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="TheInterfaceKit_GeneralConstants.html" title="General Constants"><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="TheInterfaceKit_DefinedTypes.html" title="Defined Types"><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="TheInterfaceKit_GeneralConstants.html">General Constants</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="TheInterfaceKit_DefinedTypes.html">Defined Types</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="TheInterfaceKit_MessageConstants"></a>Message Constants</h2></div></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="TheInterfaceKit_MessageConstants_Container"></a>Container Messages</h3></div></div></div><ul class="itemizedlist nomarker"><li><a class="link" href="TheInterfaceKit_MessageConstants.html#B_MIME_DATA" title="B_MIME_DATA"><code class="constant">B_MIME_DATA</code></a></li><li><a class="link" href="TheInterfaceKit_MessageConstants.html#B_SIMPLE_DATA" title="B_SIMPLE_DATA"><code class="constant">B_SIMPLE_DATA</code></a></li></ul><p>A few constants identify messages as data containers. The system
currently uses the <code class="constant">B_MIME_DATA</code> and
<code class="constant">B_SIMPLE_DATA</code> constants to mark the
containers it constructs for drag-and-drop operations.</p><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="B_MIME_DATA"></a>B_MIME_DATA</h4></div></div></div><a id="id1090301" class="indexterm"></a><p>This message constant indicates that all the data in the message is
identified by <acronym class="acronym" title="Multi-purpose Internet Mail Extensions">MIME</acronym>
type names. The type code of every data field is
<code class="constant">B_MIME_TYPE</code> and the name of each field is the
<acronym class="acronym">MIME</acronym> type string.</p><p>As an example, a
<a class="link" href="BTextView.html" title="BTextView"><code class="classname">BTextView</code></a>
object puts together a
<code class="constant">B_MIME_DATA</code> message for
drag-and-drop operations. The message has the text itself in a field
named "text/plain"; the
<a class="link" href="TheInterfaceKit_DefinedTypes.html#text_run_array" title="text_run_array"><span class="type">text_run_array</span></a>
structure that describes the
character formats of the text is in a field named
"application/x-vnd.Be-text_run_array".</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="B_SIMPLE_DATA"></a>B_SIMPLE_DATA</h4></div></div></div><a id="id1090366" class="indexterm"></a><p>This message is a package for a single data element. If there are
multiple data fields in the message, they present the same data in
various formats.</p><p>For example, when the user drags selected files and directories from a
Tracker window, the Tracker packages <span class="type">entry_ref</span> references to them in a
<code class="constant">B_SIMPLE_DATA</code> message. The references are
in a <code class="varname">refs</code> array with a type
code of <a class="link" href="TheSupportKit_Constants.html#B_REF_TYPE"><code class="constant">B_REF_TYPE</code></a>.
In other words, the message has the same structure as
a <a class="link" href="TheApplicationKit_MessageConstants.html#B_REFS_RECEIVED" title="B_REFS_RECEIVED"><code class="constant">B_REFS_RECEIVED</code></a>
message, but a different what 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="TheInterfaceKit_MessageConstants_Selection"></a>Selection Messages</h3></div></div></div><ul class="itemizedlist nomarker"><li><a class="link" href="TheInterfaceKit_MessageConstants.html#B_CUT" title="B_CUT"><code class="constant">B_CUT</code></a></li><li><a class="link" href="TheInterfaceKit_MessageConstants.html#B_COPY" title="B_COPY"><code class="constant">B_COPY</code></a></li><li><a class="link" href="TheInterfaceKit_MessageConstants.html#B_PASTE" title="B_PASTE"><code class="constant">B_PASTE</code></a></li><li><a class="link" href="TheInterfaceKit_MessageConstants.html#B_SELECT_ALL" title="B_SELECT_ALL"><code class="constant">B_SELECT_ALL</code></a></li></ul><p>Declared in: <code class="filename">app/AppDefs.h</code></p><p>These messages are sent to
<a class="link" href="BTextView.html" title="BTextView"><code class="classname">BTextView</code></a> and
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
classes (which normally passes the message to a
<a class="link" href="BTextView.html" title="BTextView"><code class="classname">BTextView</code></a>
instance) to cut, copy, paste and select all items respectively.</p><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="B_CUT"></a>B_CUT</h4></div></div></div><a id="id1090511" class="indexterm"></a><p>Removes the selected items and moves it to the clipboard.</p><p>The <span class="keycap">Command</span>+<span class="keycap">X</span> key
combination is normally mapped to <code class="classname">B_CUT</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="B_COPY"></a>B_COPY</h4></div></div></div><a id="id1090549" class="indexterm"></a><p>Copies the selected items to the clipboard.</p><p>The <span class="keycap">Command</span>+<span class="keycap">C</span> key
combination is normally mapped to <code class="classname">B_COPY</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="B_PASTE"></a>B_PASTE</h4></div></div></div><a id="id1090588" class="indexterm"></a><p>Pastes items stored in the clipboard into the view.</p><p>The <span class="keycap">Command</span>+<span class="keycap">V</span> key
combination is normally mapped to <code class="classname">B_PASTE</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="B_SELECT_ALL"></a>B_SELECT_ALL</h4></div></div></div><a id="id1090626" class="indexterm"></a><p>Selects all the items in the clipboard into the view.</p><p>The <span class="keycap">Command</span>+<span class="keycap">A</span> key
combination is normally mapped to <code class="classname">B_SELECT_ALL</code></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="TheInterfaceKit_MessageConstants_StatusBar"></a>Status Bar Messages</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="B_UPDATE_STATUS_BAR"></a>B_UPDATE_STATUS_BAR</h4></div></div></div><a id="id1090675" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>Your app.</td></tr><tr><td>Target:</td><td>The <a class="link" href="BStatusBar.html" title="BStatusBar"><code class="classname">BStatusBar</code></a>
you're updating.</td></tr><tr><td>Hook:</td><td><a class="link" href="BStatusBar.html#BStatusBar_Update" title="Update()"><code class="methodname">BStatusBar::Update()</code></a></td></tr></tbody></table></div><p>You construct and send this message to a
<a class="link" href="BStatusBar.html" title="BStatusBar"><code class="classname">BStatusBar</code></a>
object to tell it to
(asynchronously) update its progress. To send the message, invoke
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>'s
<a class="link" href="BLooper.html#BLooper_PostMessage" title="PostMessage()"><code class="methodname">PostMessage()</code></a>
naming the target
<a class="link" href="BStatusBar.html" title="BStatusBar"><code class="classname">BStatusBar</code></a>
as the handler:</p><pre class="programlisting example cpp"><code class="varname">statusBar</code>-&gt;<code class="methodname">Window</code>()-&gt;<code class="methodname">PostMessage</code>(<code class="varname">theMessage</code>, <code class="varname">statusBar</code>);</pre><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">delta</code></td><td><code class="constant">B_FLOAT_TYPE</code></td><td>An increment to the object's current value.</td></tr><tr><td><code class="varname">text</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>The object's new text (<code class="constant">NULL</code>-terminated).</td></tr><tr><td><code class="varname">trailing_text</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>The object's new trailing text
(<code class="constant">NULL</code>-terminated)..</td></tr></tbody></table></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="B_RESET_STATUS_BAR"></a>B_RESET_STATUS_BAR</h4></div></div></div><a id="id1090973" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>Your app.</td></tr><tr><td>Target:</td><td><a class="link" href="BStatusBar.html#BStatusBar_Reset" title="Reset()"><code class="methodname">Reset()</code></a></td></tr><tr><td>Hook:</td><td>The
<a class="link" href="BStatusBar.html" title="BStatusBar"><code class="classname">BStatusBar</code></a>
you're resetting.</td></tr></tbody></table></div><p>You construct and send this message to a
<a class="link" href="BStatusBar.html" title="BStatusBar"><code class="classname">BStatusBar</code></a>
object to tell it to
(asynchronously) reset itself. The message also lets you reset the
object's labels. To send the message, invoke
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>'s
<a class="link" href="BLooper.html#BLooper_PostMessage" title="PostMessage()"><code class="methodname">PostMessage()</code></a>
naming the target
<a class="link" href="BStatusBar.html" title="BStatusBar"><code class="classname">BStatusBar</code></a>
as the handler:</p><pre class="programlisting example cpp"><code class="varname">statusBar</code>-&gt;<code class="methodname">Window</code>()-&gt;<code class="methodname">PostMessage</code>(<code class="varname">theMessage</code>, <code class="varname">statusBar</code>);</pre><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">label</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>The object's new label (NULL-terminated).</td></tr><tr><td><code class="varname">trailing_label</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>The object's new trailing label
(<code class="constant">NULL</code>-terminated)..</td></tr></tbody></table></div></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="TheInterfaceKit_MessageConstants_General"></a>General Constants</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="B_CONTROL_INVOKED"></a>B_CONTROL_INVOKED</h4></div></div></div><a id="id1091259" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>A <a class="link" href="BControl.html" title="BControl"><code class="classname">BControl</code></a>.</td></tr><tr><td>Target:</td><td>Selected <a class="link" href="BMessenger.html" title="BMessenger"><code class="classname">BMessenger</code></a>.</td></tr></tbody></table></div><p>This message is sent to the targeted messenger when a
<a class="link" href="BControl.html" title="BControl"><code class="classname">BControl</code></a>-derived
object is invoked.</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="TheInterfaceKit_MessageConstants_Keyboard"></a>Keyboard Messages</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="B_KEY_DOWN"></a><a id="B_KEY_UP"></a>
<a id="B_UNMAPPED_KEY_DOWN"></a>
<a id="B_UNMAPPED_KEY_UP"></a>
B_KEY_DOWN, B_KEY_UP, B_UNMAPPED_KEY_DOWN, B_UNMAPPED_KEY_UP</h4></div></div></div><a id="id1091399" class="indexterm"></a><a id="id1091408" class="indexterm"></a><a id="id1091417" class="indexterm"></a><a id="id1091426" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The focus view's <a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.</td></tr><tr><td>Hook:</td><td>
<a class="link" href="BView.html#BView_KeyDown" title="KeyDown()"><code class="methodname">BView::KeyDown()</code></a> (<code class="constant">B_KEY_DOWN</code>)<br />
<a class="link" href="BView.html#BView_KeyUp" title="KeyUp()"><code class="methodname">BView::KeyUp()</code></a> (<code class="constant">B_KEY_UP</code>)<br />
(The ...<code class="constant">UNMAPPED</code>... messages don't map to hook functions.)</td></tr></tbody></table></div><p>
<code class="constant">B_KEY_DOWN</code> is sent when the user presses (or holds down) a key that's
mapped to a character; <code class="constant">B_KEY_UP</code> is sent when the user releases the key.
<code class="constant">B_UNMAPPED_KEY_DOWN</code> and <code class="constant">B_UNMAPPED_KEY_UP</code> are sent if the key isn't
mapped to a character. This doesn't include modifier keys, which are
reported in the <code class="constant">B_MODIFIERS_CHANGED</code> message.
</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">key</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The code for the physical key that was pressed. See &lt;x&gt; for the key map.</td></tr><tr><td><code class="varname">be:key_repeat</code> (<code class="constant">B_KEY_DOWN</code> only)</td><td><code class="constant">B_INT32_TYPE</code></td><td>The "iteration number" of this key down.
When the user holds the key down, successive messages are sent with
increasing key repeat values. This field isn't present in the initial
event; the first repeat message (i.e., the second key down message) has a
key repeat value of 1.</td></tr><tr><td><code class="varname">modifiers</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The modifier keys that were in effect at the
time of the event. See &lt;x&gt; for a list of values.</td></tr><tr><td><code class="varname">states</code></td><td><code class="constant">B_UINT8_TYPE</code></td><td>The state of all keys at the time of the event. See
&lt;x&gt;.</td></tr><tr><td><code class="varname">byte</code> [3]
(<code class="constant">B_KEY_DOWN</code> and <code class="constant">B_KEY_UP</code> only)</td><td><code class="constant">B_INT8_TYPE</code></td><td>The UTF8 data that's generated</td></tr><tr><td><code class="varname">bytes</code>
(<code class="constant">B_KEY_DOWN</code> and <code class="constant">B_KEY_UP</code> only)</td><td><code class="constant">B_STRING_TYPE</code></td><td>The string that's generated.
(The string usually contains a single character.)</td></tr><tr><td><code class="varname">raw_char</code>
(<code class="constant">B_KEY_DOWN</code> and <code class="constant">B_KEY_UP</code> only)</td><td><code class="constant">B_INT32_TYPE</code></td><td>Modifier-independent ASCII code for the character.</td></tr></tbody></table></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="B_MODIFIERS_CHANGED"></a>B_MODIFIERS_CHANGED</h4></div></div></div><a id="id1091847" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The focus view's window.</td></tr><tr><td>Hook:</td><td> </td></tr></tbody></table></div><p>Sent when the user presses or releases a modifier key.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">modifiers</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The current modifier keys.</td></tr><tr><td><code class="varname">be:old_modifiers</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The previous modifier keys.</td></tr><tr><td><code class="varname">states</code></td><td><code class="constant">B_UINT8_TYPE</code></td><td>The state of all keys at the time of the event. See
&lt;x&gt;.</td></tr></tbody></table></div></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="TheInterfaceKit_MessageConstants_Mouse"></a>Mouse Messages</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="B_MOUSE_DOWN"></a>B_MOUSE_DOWN</h4></div></div></div><a id="id1092099" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
of the view the mouse is pointing to.</td></tr><tr><td>Hook:</td><td><a class="link" href="BView.html#BView_MouseDown" title="MouseDown()"><code class="methodname">BView::MouseDown()</code></a></td></tr></tbody></table></div><p>Sent when the user presses a mouse button. This message is only sent if
no other mouse button is already down.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">where</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>Mouse location in the view's coordinate system.</td></tr><tr><td><code class="varname">modifiers</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The modifier keys that were in effect at the
time of the event.</td></tr><tr><td><code class="varname">buttons</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The mouse button that was pressed, one of:
<code class="constant">B_PRIMARY_MOUSE_BUTTON</code>,
<code class="constant">B_SECONDARY_MOUSE_BUTTON</code>,
<code class="constant">B_TERTIARY_MOUSE_BUTTON</code></td></tr><tr><td><code class="varname">clicks</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>1 for a single-click, 2 for double-click, 3 for
triple-click, and so on. The counter is reset if the time between clicks
exceeds the "Double-click speed" set by the user in the Mouse
preferences. Note that the counter is not reset if the mouse moves
between clicks.</td></tr></tbody></table></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="B_MOUSE_MOVED"></a>B_MOUSE_MOVED</h4></div></div></div><a id="id1092389" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
of the view the mouse is pointing to.</td></tr><tr><td>Hook:</td><td><a class="link" href="BView.html#BView_MouseMoved" title="MouseMoved()"><code class="methodname">BView::MouseMoved()</code></a></td></tr></tbody></table></div><p>Sent when the user moves the mouse.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">where</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>The mouse's new location in window coordinates.</td></tr><tr><td><code class="varname">buttons</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The mouse buttons that are down. Zero or more of:
<code class="constant">B_PRIMARY_MOUSE_BUTTON</code>,
<code class="constant">B_SECONDARY_MOUSE_BUTTON</code>,
<code class="constant">B_TERTIARY_MOUSE_BUTTON</code></td></tr></tbody></table></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="B_MOUSE_UP"></a>B_MOUSE_UP</h4></div></div></div><a id="id1092635" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td><a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
of the view the mouse is pointing to.</td></tr><tr><td>Hook:</td><td><a class="link" href="BView.html#BView_MouseUp" title="MouseUp()"><code class="methodname">BView::MouseUp()</code></a></td></tr></tbody></table></div><p>Sent when the user releases a mouse button. It's only sent if no other
mouse button remains down.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">where</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>Mouse location in the view's coordinate system.</td></tr><tr><td><code class="varname">modifiers</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The modifier keys that were in effect at the
time of the event.</td></tr></tbody></table></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="B_MOUSE_WHEEL_CHANGED"></a>B_MOUSE_WHEEL_CHANGED</h4></div></div></div><a id="id1092870" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
of the view the mouse is pointing to.</td></tr><tr><td>Hook:</td><td> </td></tr></tbody></table></div><p>Sent when the user moves the mouse wheel (on mice that have them).</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">be:wheel_delta_x</code></td><td><code class="constant">B_FLOAT_TYPE</code></td><td>How much the Y value of the wheel has changed.</td></tr><tr><td><code class="varname">be:wheel_delta_y</code></td><td><code class="constant">B_FLOAT_TYPE</code></td><td>How much the Y value of the wheel has changed.</td></tr></tbody></table></div><p>The standard mouse driver that comes with BeOS only supports a Y-oriented
wheel.</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="B_PRINTER_CHANGED"></a>B_PRINTER_CHANGED</h3></div></div></div><a id="id1093107" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The Print Server.</td></tr><tr><td>Target:</td><td>Everyone.</td></tr><tr><td>Hook:</td><td> </td></tr></tbody></table></div><p>Sent whenever the user changes printers. Applications that support
printing should watch for this message, and if they receive it, they
should suggest that the user check their page setup the next time they
choose to print.</p></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="B_SCREEN_CHANGED"></a>B_SCREEN_CHANGED</h3></div></div></div><a id="id1093215" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>Every <a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
in the screen that changed (even hidden windows).</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_ScreenChanged" title="ScreenChanged()"><code class="methodname">BWindow::ScreenChanged()</code></a></td></tr></tbody></table></div><p>Sent when the screen's dimensions or color space changes—because
the user played with the Screen preferences app, for example.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">frame</code></td><td><code class="constant">B_RECT_TYPE</code></td><td>The screen's dimensions.</td></tr><tr><td><code class="varname">mode</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The screen's color space:
<code class="constant">B_CMAP8</code>, <code class="constant">B_RGB15</code>,
<code class="constant">B_RGB15</code>, or <code class="constant">BRGB32</code>.</td></tr></tbody></table></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="B_VALUE_CHANGED"></a>B_VALUE_CHANGED</h3></div></div></div><a id="id1093466" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The manipulated scrollbar's
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.</td></tr><tr><td>Hook:</td><td><a class="link" href="BScrollBar.html#BScrollBar_ValueChanged" title="ValueChanged()"><code class="methodname">BScrollBar::ValueChanged()</code></a></td></tr></tbody></table></div><p>Sent when the user plays with a scrollbar.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">value</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The scrollbar's new value.</td></tr></tbody></table></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="TheInterfaceKit_MessageConstants_View"></a>View Messages</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="B_VIEW_MOVED"></a>B_VIEW_MOVED</h4></div></div></div><a id="id1093690" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The moved view's
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.</td></tr><tr><td>Hook:</td><td><a class="link" href="BView.html#BView_FrameMoved" title="FrameMoved()"><code class="methodname">BView::FrameMoved()</code></a></td></tr></tbody></table></div><p>Sent when a view's origin (left top corner) changes relative to the
origin of its parent. The message isn't sent if the view doesn't have the
<code class="constant">B_FRAME_EVENTS</code> flag set.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">where</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>The view's new origin in the coordinate system of
its parent.</td></tr></tbody></table></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="B_VIEW_RESIZED"></a>B_VIEW_RESIZED</h4></div></div></div><a id="id1093910" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The resized view's
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.</td></tr><tr><td>Hook:</td><td><a class="link" href="BView.html#BView_FrameResized" title="FrameResized()"><code class="methodname">BView::FrameResized()</code></a></td></tr></tbody></table></div><p>Sent when the size of the view's frame changes. The message isn't sent if
the view doesn't have the <code class="constant">B_FRAME_EVENTS</code> flag set.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">width</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The view's new width.</td></tr><tr><td><code class="varname">height</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The view's new height.</td></tr><tr><td><code class="varname">where</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>The view's new origin expressed in the coordinate
system of its parent. This field is only included if the view actually
moved while being resized, and can always be ignored: If the view did
move, you'll hear about it in a separate
<a class="link" href="TheInterfaceKit_MessageConstants.html#B_VIEW_MOVED" title="B_VIEW_MOVED"><code class="constant">B_VIEW_MOVED</code></a>
<a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a>.</td></tr></tbody></table></div></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="TheInterfaceKit_MessageConstants_Window"></a>Window Messages</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="B_WINDOW_ACTIVATED"></a>B_WINDOW_ACTIVATED</h4></div></div></div><a id="id1094197" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The activated/deactivated
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_WindowActivated" title="WindowActivated()"><code class="methodname">BWindow::WindowActivated()</code></a> and
<a class="link" href="BView.html#BView_WindowActivated" title="WindowActivated()"><code class="methodname">BView::WindowActivated()</code></a></td></tr></tbody></table></div><p>Sent just after a window is activated or deactivated. Note that the
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
invokes <a class="link" href="BView.html#BView_WindowActivated" title="WindowActivated()"><code class="methodname">WindowActivated()</code></a>
on each of its views.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">active</code></td><td><code class="constant">B_BOOL_TYPE</code></td><td><code class="constant">true</code> if the window is
now active; <code class="constant">false</code> if not.</td></tr></tbody></table></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="B_WINDOW_MOVE_BY"></a>B_WINDOW_MOVE_BY</h4></div></div></div><a id="id1094441" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable.</td></tr><tr><td>Source:</td><td>Your application.</td></tr><tr><td>Target:</td><td>The
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
to be moved.</td></tr><tr><td>Hook:</td><td> </td></tr></tbody></table></div><p>You can send this message to a window to resize it by the specified
deltas.</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">data</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>The amount by which to move the window's X and Y
coordinates.</td></tr></tbody></table></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="B_WINDOW_MOVE_TO"></a>B_WINDOW_MOVE_TO</h4></div></div></div><a id="id1094632" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable.</td></tr><tr><td>Source:</td><td>Your application.</td></tr><tr><td>Target:</td><td>The
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
to be moved.</td></tr><tr><td>Hook:</td><td> </td></tr></tbody></table></div><p>You can send this message to a window to resize it to the specified size.</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">data</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>The width and height (in X and Y) to resize the
window to.</td></tr></tbody></table></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="B_WINDOW_MOVED"></a>B_WINDOW_MOVED</h4></div></div></div><a id="id1094822" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td><a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
that moved.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_FrameMoved" title="FrameMoved(), FrameResized()"><code class="methodname">BWindow::FrameMoved()</code></a></td></tr></tbody></table></div><p>Sent when a window's origin (left top corner) changes within the screen
coordinate system.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">where</code></td><td><code class="constant">B_POINT_TYPE</code></td><td>The window's new origin in screen coordinates.</td></tr></tbody></table></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="B_WINDOW_RESIZED"></a>B_WINDOW_RESIZED</h4></div></div></div><a id="id1095037" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The resized
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_FrameResized"><code class="methodname">BWindow::FrameResized()</code></a></td></tr></tbody></table></div><p>Sent when the size of the window's frame changes. Note that
the <code class="varname">width</code>
and <code class="varname">height</code> fields measure
the window's content area—they don't
include the window border or window tab.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">width</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The width of the window's content area.</td></tr><tr><td><code class="varname">height</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The height of the window's content area.</td></tr></tbody></table></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="B_WORKSPACE_ACTIVATED"></a>B_WORKSPACE_ACTIVATED</h4></div></div></div><a id="id1095286" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>Every
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
in the activated and deactivated workspaces.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_WorkspaceActivated" title="WorkspaceActivated()"><code class="methodname">BWindow::WorkspaceActivated()</code></a></td></tr></tbody></table></div><p>Sent when the active workspace changes.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">workspace</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The index of the window's workspace.</td></tr><tr><td><code class="varname">active</code></td><td><code class="constant">B_BOOL_TYPE</code></td><td><code class="constant">true</code> if the workspace is now
active; <code class="constant">false</code> if not.</td></tr></tbody></table></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="B_WORKSPACES_CHANGED"></a>B_WORKSPACES_CHANGED</h4></div></div></div><a id="id1095528" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
whose set of workspaces changed.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_WorkspacesChanged" title="WorkspacesChanged()"><code class="methodname">BWindow::WorkspacesChanged()</code></a></td></tr></tbody></table></div><p>Sent when there's a change to the set of workspaces in which a window can
appear.</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr><tr><td><code class="varname">old</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The window's old workspace set, given as a vector of
workspace indices.</td></tr><tr><td><code class="varname">new</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The window's new workspace set, given as a vector of
workspace indices.</td></tr></tbody></table></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="B_ZOOM"></a>B_ZOOM</h4></div></div></div><a id="id1095765" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td>The <a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
that was zoomed.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_Zoom" title="Zoom()"><code class="methodname">BWindow::Zoom()</code></a></td></tr></tbody></table></div><p>Sent when the user clicks a window's zoom button.</p><p>The message has just one data field:</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70</td></tr></tbody></table></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="B_OPEN_IN_WORKSPACE"></a>B_OPEN_IN_WORKSPACE</h4></div></div></div><a id="id1095965" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system.</td></tr><tr><td>Target:</td><td><a class="link" href="BApplication.html" title="BApplication"><code class="classname">BApplication</code></a>.</td></tr><tr><td>Hook:</td><td> </td></tr></tbody></table></div><p>Sent to an application when it's first launched to tell it to open in a
specific workspace. The message will be handled during the construction
of the <a class="link" href="BApplication.html" title="BApplication"><code class="classname">BApplication</code></a>
object.</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">be:workspace</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>Workspace number into which the application
should open.</td></tr></tbody></table></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="B_MINIMIZE"></a>B_MINIMIZE</h4></div></div></div><a id="id1096162" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable</td></tr><tr><td>Source:</td><td>The system or your app.</td></tr><tr><td>Target:</td><td>The <a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
that's hidden/unhidden.</td></tr><tr><td>Hook:</td><td><a class="link" href="BWindow.html#BWindow_Minimize"><code class="methodname">BWindow::Minimize()</code></a></td></tr></tbody></table></div><p>Sent when the user double-clicks a window's title bar (to hide the
window), or selects a window from the DeskBar's window list (to unhide
the window).</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">when</code></td><td><code class="constant">B_INT64_TYPE</code></td><td>Event time, in microseconds since 01/01/70.</td></tr><tr><td><code class="varname">minimize</code></td><td><code class="constant">B_BOOL_TYPE</code></td><td><code class="constant">true</code> if the
window is being hidden; <code class="constant">false</code> if it's
being unhidden.</td></tr></tbody></table></div></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="TheInterfaceKit_MessageConstants_Shelf"></a>BShelf Messages</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="B_ARCHIVED_OBJECT"></a>B_ARCHIVED_OBJECT</h4></div></div></div><a id="id1096396" class="indexterm"></a><div class="informaltable"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Purpose:</td><td>Deliverable and format</td></tr><tr><td>Source:</td><td>A dragged replicant, or your app.</td></tr><tr><td>Target:</td><td>A (remote) application.</td></tr><tr><td>Hook:</td><td><a class="link" href="BShelf.html#BShelf_CanAcceptReplicantMessage" title="CanAcceptReplicantMessage(), CanAcceptReplicantView()"><code class="methodname">BShelf::CanAcceptReplicantMessage()</code></a></td></tr></tbody></table></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h5 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1096494"></a>As a deliverable:</h5></div></div></div><p>The replicant system uses this message as a
deliverable. If you're using
<a class="link" href="BDragger.html" title="BDragger"><code class="classname">BDragger</code></a> and
<a class="link" href="BShelf.html" title="BShelf"><code class="classname">BShelf</code></a> objects, the message is
created and delivered for you. You can also simulate a dragged replicant
by archiving a view, setting the archive message's command to
<code class="constant">B_ARCHIVED_OBJECT</code>, and sending the message to a remote application. If
the remote application has a
<a class="link" href="BShelf.html" title="BShelf"><code class="classname">BShelf</code></a> object, the
<a class="link" href="BShelf.html" title="BShelf"><code class="classname">BShelf</code></a> will pick up the
message (through a <a class="link" href="BMessageFilter.html" title="BMessageFilter"><code class="classname">BMessageFilter</code></a>)
and pass it to the hook function.</p><p>To create a simulated replicant message, you call
<a class="link" href="BView.html#BView_Archive" title="Archive()"><code class="methodname">Archive()</code></a> on the view
that you want to replicate, and add (at least) the
<code class="varname">add_on</code> field to the
archive message.</p><p>See <a class="link" href="BShelf.html" title="BShelf"><code class="classname">BShelf</code></a> and
<a class="link" href="BDragger.html" title="BDragger"><code class="classname">BDragger</code></a> for
more information about replicants.</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"><h5 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1096587"></a>As a format:</h5></div></div></div><p><code class="constant">B_ARCHIVED_OBJECT</code>
should be used as the command constant for
all archive messages. When you archive an object, the <code class="varname">class</code> field is
automatically added to the archive message. All other fields must be
added by your archiving code. See the
<a class="link" href="BArchivable.html" title="BArchivable"><code class="classname">BArchivable</code></a> class for more
information about archiving.
</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">class</code> [ ]</td><td><code class="constant">B_STRING_TYPE</code></td><td>An array of class names that gives the class
hierarchy of the archived object.</td></tr><tr><td><code class="varname">add_on</code></td><td><code class="constant">B_STRING_TYPE</code></td><td>The signature of the library or application that
knows how to create the archived object.</td></tr><tr><td><code class="varname">be:add_on_version</code></td><td><code class="constant">B_INT32_TYPE</code></td><td>The version of the add_on.</td></tr><tr><td><code class="varname">be:load_each_time</code></td><td><code class="constant">B_BOOL_TYPE</code></td><td><code class="constant">true</code>: The add_on is loaded each time the
object is unarchived. <code class="constant">false</code>: The add_on is
loaded only if it isn't already loaded.</td></tr><tr><td><code class="varname">be:unload_on_delete</code></td><td><code class="constant">B_BOOL_TYPE</code></td><td>Is the add_on unloaded when the
unarchived object is deleted?</td></tr><tr><td><code class="varname">shelf_type</code>
(replicants only; optional)</td><td><code class="constant">B_STRING_TYPE</code></td><td>The <code class="varname">type</code> of shelf that you
want to have display the replicant. A shelf's type is its name, as
assigned when it's created.</td></tr></tbody></table></div></div></div></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="TheInterfaceKit_GeneralConstants.html">General Constants</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="TheInterfaceKit_DefinedTypes.html">Defined Types</a> </div><div id="footerB"><div id="footerBL"><a href="TheInterfaceKit_GeneralConstants.html" title="General Constants"><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="TheInterfaceKit_DefinedTypes.html" title="Defined Types"><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