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

384 lines
54 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_Functions.html" title="Functions" /><link rel="next" href="TheInterfaceKit_MessageConstants.html" title="Message Constants" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="TheInterfaceKit_Functions.html" title="Functions"><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_MessageConstants.html" title="Message Constants"><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_Functions.html">Functions</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="TheInterfaceKit_MessageConstants.html">Message Constants</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_GeneralConstants"></a>General 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="alignment"></a>alignment Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting definition c">enum <span class="type">alignment</span> {
<code class="constant">B_ALIGN_LEFT</code>,
<code class="constant">B_ALIGN_RIGHT</code>,
<code class="constant">B_ALIGN_CENTER</code></pre><p>These constants define the <span class="type">alignment</span> data type. They
determine how lines of text and labels are aligned by
<a class="link" href="BTextView.html" title="BTextView"><code class="classname">BTextView</code></a>,
<a class="link" href="BStringView.html" title="BStringView"><code class="classname">BStringView</code></a>, and
<a class="link" href="BMenuField.html" title="BMenuField"><code class="classname">BMenuField</code></a>
objects.</p><p>See also:
<a class="link" href="BTextView.html#BTextView_SetAlignment" title="SetAlignment(), Alignment()"><code class="methodname">BTextView::SetAlignment()</code></a></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="border_style"></a>border_style Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting definition c">enum <span class="type">border_style</span> {
<code class="constant">B_PLAIN_BORDER</code>,
<code class="constant">B_FANCY_BORDER</code>,
<code class="constant">B_NO_BORDER</code></pre><p>These constants define how
<a class="link" href="BBox.html" title="BBox"><code class="classname">BBox</code></a>
objects and
<a class="link" href="BScrollView.html" title="BScrollView"><code class="classname">BScrollView</code></a>s
are bordered.</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="Constants_Character"></a>Character Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Character value</th></tr></thead><tbody><tr><td><code class="constant">B_BACKSPACE</code></td><td>0x08 (same as 'b')</td></tr><tr><td><code class="constant">B_ENTER</code></td><td>0x0a (same as 'n')</td></tr><tr><td><code class="constant">B_RETURN</code></td><td>0x0a (synonym for <code class="constant">B_ENTER</code>)</td></tr><tr><td><code class="constant">B_SPACE</code></td><td>0x20 (same as ' ')</td></tr><tr><td><code class="constant">B_TAB</code></td><td>0x09 (same as 't')</td></tr><tr><td><code class="constant">B_ESCAPE</code></td><td>0x1b</td></tr><tr><td><code class="constant">B_LEFT_ARROW</code></td><td>0x1c</td></tr><tr><td><code class="constant">B_RIGHT_ARROW</code></td><td>0x1d</td></tr><tr><td><code class="constant">B_UP_ARROW</code></td><td>0x1e</td></tr><tr><td><code class="constant">B_DOWN_ARROW</code></td><td>0x1f</td></tr><tr><td><code class="constant">B_INSERT</code></td><td>0x05</td></tr><tr><td><code class="constant">B_DELETE</code></td><td>0x7f</td></tr><tr><td><code class="constant">B_HOME</code></td><td>0x01</td></tr><tr><td><code class="constant">B_END</code></td><td>0x04</td></tr><tr><td><code class="constant">B_PAGE_UP</code></td><td>0x0b</td></tr><tr><td><code class="constant">B_PAGE_DOWN</code></td><td>0x0c</td></tr><tr><td><code class="constant">B_FUNCTION_KEY</code></td><td>0x10</td></tr><tr><td><code class="constant">B_UTF8_ELLIPSIS</code></td><td>"xE2x80xA6"</td></tr><tr><td><code class="constant">B_UTF8_OPEN_QUOTE</code></td><td>"xE2x80x9C"</td></tr><tr><td><code class="constant">B_UTF8_CLOSE_QUOTE</code></td><td>"xE2x80x9D"</td></tr><tr><td><code class="constant">B_UTF8_COPYRIGHT</code></td><td>"xC2xA9"</td></tr><tr><td><code class="constant">B_UTF8_REGISTERED</code></td><td>"xC2xAE"</td></tr><tr><td><code class="constant">B_UTF8_TRADEMARK</code></td><td>"xE2x84xA2"</td></tr><tr><td><code class="constant">B_UTF8_SMILING_FACE</code></td><td>"xE2x98xBB"</td></tr><tr><td><code class="constant">B_UTF8_HIROSHI</code></td><td>"xE5xBCx98"</td></tr></tbody></table></div><p>
Constants in the first group stand for the ASCII characters they name.
They're defined only for characters that normally don't have visible
symbols.
</p><p>
Constants in the second group are Unicode UTF-8 encodings of common
characters that have multibyte representations. These constants are
strings that can be concatenated with other strings—for example, to
set a button label that ends in an ellipsis:
</p><pre class="programlisting example cpp"><code class="varname">myButton</code>-&gt;<code class="methodname">SetLabel</code>("Options"<code class="constant">B_UTF_ELLIPSIS</code>);</pre><p>
See also:
"<a class="link" href="TheInterfaceKit_GeneralConstants.html#Constants_Function_Key" title="Function Key Constants">Function Key Constants</a>" below
</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="color_space"></a>color_space</h3></div></div></div><p>Declared in: <code class="filename">interface/GraphicsDefs.h</code></p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_NO_COLOR_SPACE</code></td><td>Undefined color space</td></tr><tr><td><code class="constant">B_RGB32</code></td><td>xRGB 8:8:8:8, stored as little endian uint32</td></tr><tr><td><code class="constant">B_RGBA32</code></td><td>ARGB 8:8:8:8, stored as little endian uint32</td></tr><tr><td><code class="constant">B_RGB24</code></td><td>Currently unused</td></tr><tr><td><code class="constant">B_RGB16</code></td><td>xRGB 5:6:5, stored as little endian uint16</td></tr><tr><td><code class="constant">B_RGB15</code></td><td>RGB 1:5:5:5, stored as little endian uint16</td></tr><tr><td><code class="constant">B_RGBA15</code></td><td>ARGB 1:5:5:5, stored as little endian uint16</td></tr><tr><td><code class="constant">B_CMAP8</code></td><td>256-color index into the color table.</td></tr><tr><td><code class="constant">B_GRAY8</code></td><td>256-color greyscale value.</td></tr><tr><td><code class="constant">B_GRAY1</code></td><td>Each bit represents a single pixel, where 0 is the view's low
color and 1 is the high color.</td></tr><tr><td><code class="constant">B_RGB32_BIG</code></td><td>xRGB 8:8:8:8, stored as big endian uint32</td></tr><tr><td><code class="constant">B_RGBA32_BIG</code></td><td>ARGB 8:8:8:8, stored as big endian uint32</td></tr><tr><td><code class="constant">B_RGB24_BIG</code></td><td>Currently unused</td></tr><tr><td><code class="constant">B_RGB16_BIG</code></td><td>RGB 5:6:5, stored as big endian uint16</td></tr><tr><td><code class="constant">B_RGB15_BIG</code></td><td>xRGB 1:5:5:5, stored as big endian uint16</td></tr><tr><td><code class="constant">B_RGBA15_BIG</code></td><td>ARGB 1:5:5:5, stored as big endian uint16</td></tr><tr><td><code class="constant">B_YCbCr422</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YCbCr411</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YCbCr444</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YCbCr420</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YUV422</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YUV411</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YUV420</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YUV444</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YUV9</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_YUV12</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_UVL24</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_UVL32</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_UVLA32</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_LAB24</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_LAB32</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_LABA32</code></td><td>Currently unused.</td></tr><tr><td><code class="constant">B_HSI24</code></td><td>Hue, saturation, and intensity: x:8:8:8 format</td></tr><tr><td><code class="constant">B_HSI32</code></td><td>Hue, saturation, and intensity: 8:8:8 format</td></tr><tr><td><code class="constant">B_HSIA32</code></td><td>Hue, saturation, intensity, and alpha: 8:8:8:8 format</td></tr><tr><td><code class="constant">B_HSV24</code></td><td>Hue, saturation, and value: x:8:8:8 format</td></tr><tr><td><code class="constant">B_HSV32</code></td><td>Hue, saturation, and value: 8:8:8 format</td></tr><tr><td><code class="constant">B_HSVA32</code></td><td>Hue, saturation, value, and alpha: 8:8:8:8 format</td></tr><tr><td><code class="constant">B_HLS24</code></td><td>Hue, lightness, and saturation: x:8:8:8 format</td></tr><tr><td><code class="constant">B_HLS32</code></td><td>Hue, lightness, and saturation: 8:8:8 format</td></tr><tr><td><code class="constant">B_HLSA32</code></td><td>Hue, lightness, saturation, and alpha: 8:8:8:8 format</td></tr><tr><td><code class="constant">B_CMY24</code></td><td>Cyan, magenta, and yellow: x:8:8:8 format</td></tr><tr><td><code class="constant">B_CMY32</code></td><td>Cyan, magenta, and yellow: 8:8:8 format</td></tr><tr><td><code class="constant">B_CMYA32</code></td><td>Cyan, magenta, yellow, and alpha: 8:8:8:8 format</td></tr><tr><td><code class="constant">B_CMYK32</code></td><td>Cyan, magenta, yellow, and black: 8:8:8:8 format</td></tr><tr><td><code class="constant">B_MONOCHROME_1_BIT</code></td><td>For compatibility only: use B_GRAY1</td></tr><tr><td><code class="constant">B_GRAYSCALE_8_BIT</code></td><td>For compatibility only; use B_GRAY8</td></tr><tr><td><code class="constant">B_COLOR_8_BIT</code></td><td>For compatibility only; use B_CMAP8</td></tr><tr><td><code class="constant">B_RGB_32_BIT</code></td><td>For compatibility only; use B_RGB32</td></tr><tr><td><code class="constant">B_RGB_16_BIT</code></td><td>For compatibility only; use B_RGB15</td></tr><tr><td><code class="constant">B_BIG_RGB_32_BIT</code></td><td>For compatibility only; use B_RGB32_BIG</td></tr><tr><td><code class="constant">B_BIG_RGB_16_BIT</code></td><td>For compatibility only; use B_RGB15_BIG</td></tr></tbody></table></div><p>
These constants define the <span class="type">color_space</span> data type. A color space describes
three properties of screens and bitmap images:
</p><ul class="itemizedlist"><li><p>
How many bits of information there are per pixel (the depth of the
image)
</p></li><li><p>
How those bits are to be interpreted (whether as colors or on a
grayscale, what the color components are, and so on).
</p></li><li><p>
How are components are arranged
</p></li></ul><p>
A number of these aren't actually usable as screen display color spaces,
but are intended for use in identifying the color format for video media
buffers and other offscreen graphics data.
</p><p>
See the
"<a class="link" href="TheInterfaceKit_Drawing.html#TheInterfaceKit_Drawing_Color_Spaces" title="Color Spaces">Color Spaces</a>"
section in the
"<a class="link" href="TheInterfaceKit_Drawing.html" title="Drawing">Drawing</a>"
section of this chapter
for a fuller explanation of these color spaces.
</p><p>
See also: the
<a class="link" href="BBitmap.html" title="BBitmap"><code class="classname">BBitmap</code></a>
and <a class="link" href="BScreen.html" title="BScreen"><code class="classname">BScreen</code></a> classes
</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="Constants_Control_Values"></a>Control Values</h3></div></div></div><p>
Declared in: <code class="filename">interface/Control.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Value</th></tr></thead><tbody><tr><td><code class="constant">B_CONTROL_ON</code></td><td>1</td></tr><tr><td><code class="constant">B_CONTROL_OFF</code></td><td>0</td></tr></tbody></table></div><p>
These constants define the bipolar states of a typical control device.
</p><p>
See also:
<a class="link" href="BControl.html#BControl_SetValue" title="SetValue(), Value()"><code class="methodname">BControl::SetValue()</code></a>
</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="Constants_Cursor_Transit"></a>Cursor Transit Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/View.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_ENTERED_VIEW</code></td><td>The cursor has just entered a view.</td></tr><tr><td><code class="constant">B_INSIDE_VIEW</code></td><td>The cursor has moved within the view.</td></tr><tr><td><code class="constant">B_EXITED_VIEW</code></td><td>The cursor has left the view</td></tr></tbody></table></div><p>
These constants describe the cursor's transit through a view. Each
<a class="link" href="BView.html#BView_MouseMoved" title="MouseMoved()"><code class="methodname">MouseMoved()</code></a>
notification includes one of these constants as an argument,
to inform the
<a class="link" href="BView.html" title="BView"><code class="classname">BView</code></a>
whether the cursor has entered the view, moved while
inside the view, or exited the view.
</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="Constants_Dead_Key_Mapping"></a>Dead-Key Mapping</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_CONTROL_TABLE</code></td></tr><tr><td><code class="constant">B_OPTION_CAPS_SHIFT_TABLE</code></td></tr><tr><td><code class="constant">B_OPTION_CAPS_TABLE</code></td></tr><tr><td><code class="constant">B_OPTION_SHIFT_TABLE</code></td></tr><tr><td><code class="constant">B_OPTION_TABLE</code></td></tr><tr><td><code class="constant">B_CAPS_SHIFT_TABLE</code></td></tr><tr><td><code class="constant">B_CAPS_TABLE</code></td></tr><tr><td><code class="constant">B_SHIFT_TABLE</code></td></tr><tr><td><code class="constant">B_NORMAL_TABLE</code></td></tr></tbody></table></div><p>
These constants determine which combinations of modifiers can cause a key
to be the "dead" member of a two-key combination.
</p><p>
See also:
<a class="link" href="TheInputServer_Functions.html#get_key_map" title="get_key_map()"><code class="function">get_key_map()</code></a>
</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="drawing_mode"></a>drawing_mode Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/GraphicsDefs.h</code>
</p><pre class="programlisting definition c">enum <span class="type">drawing_mode</span> {
<code class="constant">B_OP_COPY</code>,
<code class="constant">B_OP_OVER</code>,
<code class="constant">B_OP_ERASE</code>,
<code class="constant">B_OP_INVERT</code>,
<code class="constant">B_OP_SELECT</code>,
<code class="constant">B_OP_ALPHA</code>,
<code class="constant">B_OP_ADD</code>,
<code class="constant">B_OP_SUBTRACT</code>,
<code class="constant">B_OP_BLEND</code>,
<code class="constant">B_OP_MIN</code>,
<code class="constant">B_OP_MAX</code></pre><p>
These constants define the <span class="type">drawing_mode</span> data type. The drawing mode is a
<a class="link" href="BView.html" title="BView"><code class="classname">BView</code></a>
graphics parameter that determines how the image being drawn
interacts with the image already in place in the area where it's drawn.
The various modes are explained under
"<a class="link" href="TheInterfaceKit_Drawing.html#TheInterfaceKit_Drawing_Drawing_Modes" title="Drawing Modes">Drawing Modes</a>" in the
"<a class="link" href="TheInterfaceKit_Drawing.html" title="Drawing">Drawing</a>"
section of this chapter.
</p><p>
See also:
<a class="link" href="BView.html#BView_SetDrawingMode" title="SetDrawingMode(), DrawingMode()"><code class="methodname">BView::SetDrawingMode()</code></a>
</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="Constants_Function_Key"></a>Function Key Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_F1_KEY</code></td></tr><tr><td><code class="constant">B_F2_KEY</code></td></tr><tr><td><code class="constant">B_F3_KEY</code></td></tr><tr><td><code class="constant">B_F4_KEY</code></td></tr><tr><td><code class="constant">B_F5_KEY</code></td></tr><tr><td><code class="constant">B_F6_KEY</code></td></tr><tr><td><code class="constant">B_F7_KEY</code></td></tr><tr><td><code class="constant">B_F8_KEY</code></td></tr><tr><td><code class="constant">B_F9_KEY</code></td></tr><tr><td><code class="constant">B_F10_KEY</code></td></tr><tr><td><code class="constant">B_F11_KEY</code></td></tr><tr><td><code class="constant">B_F12_KEY</code></td></tr><tr><td><code class="constant">B_PRINT_KEY</code> (the "Print Screen" key)</td></tr><tr><td><code class="constant">B_SCROLL_KEY</code> (the "Scroll Lock" key)</td></tr><tr><td><code class="constant">B_PAUSE_KEY</code></td></tr></tbody></table></div><p>
These constants stand for the various keys that are mapped to the
<code class="constant">B_FUNCTION_KEY</code> character. When the
<code class="constant">B_FUNCTION_KEY</code> character is reported
in a key-down event, the application can determine which key produced the
character by testing the key code against these constants. (
<span class="keycap">Control</span>+<span class="keycap">p</span>
also produces the <code class="constant">B_FUNCTION_KEY</code> character.)
</p><p>
See also:
"Character Mapping" in the
<a class="link" href="TheKeyboard.html" title="The Keyboard">Keyboard Information</a> appendix
</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="Constants_Interface_Messages"></a>Interface Messages</h3></div></div></div><p>
Declared in: <code class="filename">app/AppDefs.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_ZOOM</code></td></tr><tr><td><code class="constant">B_MINIMIZE</code></td></tr><tr><td><code class="constant">B_WINDOW_RESIZED</code></td></tr><tr><td><code class="constant">B_WINDOW_MOVED</code></td></tr><tr><td><code class="constant">B_WINDOW_ACTIVATED</code></td></tr><tr><td><a class="link" href="TheApplicationKit_MessageConstants.html#B_QUIT_REQUESTED" title="B_QUIT_REQUESTED"><code class="constant">B_QUIT_REQUESTED</code></a></td></tr><tr><td><code class="constant">B_SCREEN_CHANGED</code></td></tr><tr><td><code class="constant">B_WORKSPACE_ACTIVATED</code></td></tr><tr><td><code class="constant">B_WORKSPACES_CHANGED</code></td></tr><tr><td><code class="constant">B_KEY_DOWN</code></td></tr><tr><td><code class="constant">B_KEY_UP</code></td></tr><tr><td><code class="constant">B_MOUSE_DOWN</code></td></tr><tr><td><code class="constant">B_MOUSE_UP</code></td></tr><tr><td><code class="constant">B_MOUSE_MOVED</code></td></tr><tr><td><code class="constant">B_VIEW_RESIZED</code></td></tr><tr><td><code class="constant">B_VIEW_MOVED</code></td></tr><tr><td><code class="constant">B_VALUE_CHANGED</code></td></tr><tr><td><code class="constant">B_PULSE</code></td></tr></tbody></table></div><p>
These constants identify interface messages—system messages that
are delivered to <a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>
objects. Each constant conveys an instruction to
do something in particular (<code class="constant">B_ZOOM</code>) or names a type of event
(<code class="constant">B_KEY_DOWN</code>).
</p><p>
See also:
"<a class="link" href="TheInterfaceKit_Responding.html#TheInterfaceKit_Responding_InterfaceMessages" title="Interface Messages">Interface Messages</a>" in the
"<a class="link" href="TheInterfaceKit_Responding.html" title="Responding to the User">Responding to the User</a>"
section of this chapter
</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="Constants_list_view_type"></a>list_view_type Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/ListView.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_SINGLE_SELECTION_LIST</code></td></tr><tr><td><code class="constant">B_MULTIPLE_SELECTION_LIST</code></td></tr></tbody></table></div><p>
These constants distinguish between lists that permit the user to select
only one item at a time and those that allow multiple items to be
selected.
</p><p>
See also:
The <a class="link" href="BListView.html" title="BListView"><code class="classname">BListView</code></a> class
</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="Constants_Main_Screen"></a>Main Screen</h3></div></div></div><p>
Declared in: <code class="filename">interface/Screen.h</code>
</p><p>
const screen_id <code class="constant">B_MAIN_SCREEN_ID</code>
</p><p>
This constant stands for the main screen, the screen that has the origin
of the screen coordinate system at its left top corner. (Currently only
one screen can be attached to the computer and it is the main screen.)
</p><p>
See also: <a class="link" href="TheInterfaceKit_DefinedTypes.html#screen_id" title="screen_id"><span class="type">screen_id</span></a>
</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="Constants_menu_bar_border"></a>menu_bar_border Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/MenuBar.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_BORDER_FRAME</code></td><td>Put a border inside the entire frame rectangle.</td></tr><tr><td><code class="constant">B_BORDER_CONTENTS</code></td><td>Put a border around the group of items only.</td></tr><tr><td><code class="constant">B_BORDER_EACH_ITEM</code></td><td>Put a border around each item.</td></tr></tbody></table></div><p>
These constants can be passed as an argument to
<a class="link" href="BMenuBar.html" title="BMenuBar"><code class="classname">BMenuBar</code></a>'s
<a class="link" href="BMenuBar.html#BMenuBar_SetBorder" title="SetBorder(), Border()"><code class="methodname">SetBorder()</code></a>
function.
</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="Constants_menu_layout"></a>menu_layout Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/Menu.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_ITEMS_IN_ROW</code></td><td>Menu items are arranged horizontally, in a row.</td></tr><tr><td><code class="constant">B_ITEMS_IN_COLUMN</code></td><td>Menu items are arranged vertically, in a column.</td></tr><tr><td><code class="constant">B_ITEMS_IN_MATRIX</code></td><td>Menu items are arranged in a custom fashion.</td></tr></tbody></table></div><p>
These constants define the <span class="type">menu_layout</span> data type. They distinguish the
ways that items can be arranged in a menu or menu bar—they can be
laid out from end to end in a row like a typical menu bar, stacked from
top to bottom in a column like a typical menu, or arranged in some custom
fashion like a matrix.
</p><p>
See also:
The <a class="link" href="BMenu.html" title="BMenu"><code class="classname">BMenu</code></a> and
<a class="link" href="BMenuBar.html" title="BMenuBar"><code class="classname">BMenuBar</code></a> constructors
</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="Constants_Modifier_States"></a>Modifier States</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDef.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_SHIFT_KEY</code></td></tr><tr><td><code class="constant">B_LEFT_SHIFT_KEY</code></td></tr><tr><td><code class="constant">B_RIGHT_SHIFT_KEY</code></td></tr><tr><td><code class="constant">B_CONTROL_KEY</code></td></tr><tr><td><code class="constant">B_LEFT_CONTROL_KEY</code></td></tr><tr><td><code class="constant">B_RIGHT_CONTROL_KEY</code></td></tr><tr><td><code class="constant">B_CAPS_LOCK</code></td></tr><tr><td><code class="constant">B_SCROLL_LOCK</code></td></tr><tr><td><code class="constant">B_NUM_LOCK</code></td></tr><tr><td><code class="constant">B_OPTION_KEY</code></td></tr><tr><td><code class="constant">B_LEFT_OPTION_KEY</code></td></tr><tr><td><code class="constant">B_RIGHT_OPTION_KEY</code></td></tr><tr><td><code class="constant">B_COMMAND_KEY</code></td></tr><tr><td><code class="constant">B_LEFT_COMMAND_KEY</code></td></tr><tr><td><code class="constant">B_RIGHT_COMMAND_KEY</code></td></tr><tr><td><code class="constant">B_MENU_KEYB_PULSE</code></td></tr></tbody></table></div><p>
These constants designate the <span class="keycap">Shift</span>, <span class="keycap">Option</span>,
<span class="keycap">Control</span>, <span class="keycap">Command</span>, and <span class="keycap">Menu</span>
modifier keys and the lock states set by the <span class="keycap">Caps Lock</span>, <span class="keycap">Scroll Lock</span>, and
<span class="keycap">Num Lock</span> keys. They're typically used to form a mask that describes the
current, or required, modifier states.
</p><p>
For each variety of modifier key, there are constants that distinguish
between the keys that appear at the left and right of the keyboard, as
well as one that lumps both together. For example, if the user is holding
the left <span class="keycap">Control</span> key down, both <code class="constant">B_CONTROL_KEY</code>
and <code class="constant">B_LEFT_CONTROL_KEY</code> will
be set in the mask.
</p><p>
See also:
<a class="link" href="TheInputServer_Functions.html#modifiers" title="modifiers()"><code class="function">modifiers()</code></a>,
<a class="link" href="BWindow.html#BWindow_AddShortcut" title="AddShortcut(), RemoveShortcut()"><code class="methodname">BWindow::AddShortcut()</code></a>, the
<a class="link" href="BMenu.html" title="BMenu"><code class="classname">BMenu</code></a> constructor
</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="Constants_Mouse_Buttons"></a>Mouse Buttons</h3></div></div></div><p>
Declared in: <code class="filename">interface/View.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_PRIMARY_MOUSE_BUTTON</code></td></tr><tr><td><code class="constant">B_SECONDARY_MOUSE_BUTTON</code></td></tr><tr><td><code class="constant">B_TERTIARY_MOUSE_BUTTON</code></td></tr></tbody></table></div><p>
These constants name the mouse buttons. Buttons are identified, not by
their physical positions on the mouse, but by their roles in the user
interface.
</p><p>
See also:
<a class="link" href="BView.html#BView_GetMouse" title="GetMouse()"><code class="methodname">BView::GetMouse()</code></a>,
<a class="link" href="TheInputServer_Functions.html#set_mouse_map" title="set_mouse_map(), get_mouse_map(), set_mouse_type(), get_mouse_type() , set_mouse_speed(), get_mouse_speed()"><code class="function">set_mouse_map()</code></a>
</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="Constants_Orientation"></a>Orientation Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDef.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_HORIZONTAL</code></td></tr><tr><td><code class="constant">B_VERTICAL</code></td></tr></tbody></table></div><p>
These constants define the orientation data type that distinguishes
between the vertical and horizontal orientation of graphic objects. It's
currently used only to differentiate scroll bars.
</p><p>
See also:
The <a class="link" href="BScrollBar.html" title="BScrollBar"><code class="classname">BScrollBar</code></a> and
<a class="link" href="BScrollView.html" title="BScrollView"><code class="classname">BScrollView</code></a> classes
</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="Constants_Pattern"></a>Pattern Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/GraphicsDef.h</code>
</p><pre class="programlisting cpp">const <span class="type">pattern</span> <code class="constant">B_SOLID_HIGH</code> =
{ 0xff, 0xff, 0xff, 0xff, 0xff,0xff, 0xff, 0xff }
const <span class="type">pattern</span> <code class="constant">B_SOLID_LOW</code> =
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
const <span class="type">pattern</span> <code class="constant">B_MIXED_COLORS</code> =
{ 0xaa, 0x55, 0xaa, 0x55, 0xaa, 0x55, 0xaa, 0x55 }</pre><p>
These constants name the three standard patterns defined in the Interface
Kit.
</p><p>
<code class="constant">B_SOLID_HIGH</code> is a pattern that consists of the high color only. It's the
default pattern for all BView drawing functions that stroke lines and
fill shapes.
</p><p>
<code class="constant">B_SOLID_LOW</code> is a pattern with only the low color. It's used mainly to
erase images
(to replace them with the background color).
</p><p>
<code class="constant">B_MIXED_COLORS</code> alternates pixels between the high and low colors in a
checkerboard pattern. The result is a halftone midway between the two
colors. This pattern can produce fine gradations of color, especially
when the high and low colors are set to two colors that are already quite
similar.
</p><p>
See also:
"<a class="xref" href="TheInterfaceKit_Drawing.html#TheInterfaceKit_Drawing_Patterns" title="Patterns">Patterns</a>" in the
"<a class="xref" href="TheInterfaceKit_Drawing.html" title="Drawing">Drawing</a>"
section of this chapter
</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="Constants_Resizing_Modes"></a>Resizing Modes</h3></div></div></div><p>
Declared in: <code class="filename">interface/View.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_FOLLOW_LEFT</code></td></tr><tr><td><code class="constant">B_FOLLOW_RIGHT</code></td></tr><tr><td><code class="constant">B_FOLLOW_LEFT_RIGHT</code></td></tr><tr><td><code class="constant">B_FOLLOW_H_CENTER</code></td></tr><tr><td><code class="constant">B_FOLLOW_TOP</code></td></tr><tr><td><code class="constant">B_FOLLOW_BOTTOM</code></td></tr><tr><td><code class="constant">B_FOLLOW_TOP_BOTTOM</code></td></tr><tr><td><code class="constant">B_FOLLOW_V_CENTER</code></td></tr><tr><td><code class="constant">B_FOLLOW_ALL</code></td></tr><tr><td><code class="constant">B_FOLLOW_NONE</code></td></tr></tbody></table></div><p>
These constants are used to set the behavior of a view when its parent is
resized. They're explained under the <code class="classname">BView</code>
<a class="link" href="BView.html#BView_Constructor" title="BView()">constructor</a>.
</p><p>
See also:
<a class="link" href="BView.html#BView_SetResizingMode" title="SetResizingMode(), ResizingMode()"><code class="methodname">BView::SetResizingMode()</code></a>
</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="Constants_Screen_Spaces"></a>Screen Spaces</h3></div></div></div><p>
Declared in: <code class="filename">interface/GraphicsDef.h</code>
</p><pre class="programlisting"><code class="constant">B_8_BIT_640x400</code>
<code class="constant">B_8_BIT_640x480</code> <code class="constant">B_15_BIT_640x480</code>
<code class="constant">B_16_BIT_640x480</code> <code class="constant">B_32_BIT_640x480</code>
<code class="constant">B_8_BIT_800x600</code> <code class="constant">B_15_BIT_800x600</code>
<code class="constant">B_16_BIT_800x600</code> <code class="constant">B_32_BIT_800x600</code>
<code class="constant">B_8_BIT_1024x768</code> <code class="constant">B_15_BIT_1024x768</code>
<code class="constant">B_16_BIT_1024x768</code> <code class="constant">B_32_BIT_1024x768</code>
<code class="constant">B_8_BIT_1152x900</code> <code class="constant">B_15_BIT_1152x900</code>
<code class="constant">B_16_BIT_1152x900</code> <code class="constant">B_32_BIT_1152x900</code>
<code class="constant">B_8_BIT_1280x1024</code> <code class="constant">B_15_BIT_1280x1024</code>
<code class="constant">B_16_BIT_1280x1024</code> <code class="constant">B_32_BIT_1280x1024</code>
<code class="constant">B_8_BIT_1600x1200</code> <code class="constant">B_15_BIT_1600x1200</code>
<code class="constant">B_16_BIT_1600x1200</code> <code class="constant">B_32_BIT_1600x1200</code></pre><p>
These constants are currently used to configure the screen—to set
its depth and the size of the pixel grid it displays—as well as to
report which configurations are possible. However, they may not be
supported in the future. 15-bit depths are not currently supported
</p><p>
See also:
<a class="link" href="TheInterfaceKit_Functions.html#set_screen_space" title="set_screen_space()"><code class="function">set_screen_space()</code></a>,
<code class="function">get_screen_info()</code>.
</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="Constants_ScrollBar"></a>ScrollBar Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/ScrollBar.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_H_SCROLL_BAR_HEIGHT</code></td></tr><tr><td><code class="constant">B_V_SCROLL_BAR_WIDTH</code></td></tr></tbody></table></div><p>
These constants record the recommended thickness of scroll bars. They
should be used to help define the frame rectangles passed to the
<code class="classname">BScrollBar</code>
<a class="link" href="BScrollBar.html#BScrollBar_Constructor" title="BScrollBar()">constructor</a>.
</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="Constants_String_Truncation"></a>String Truncation Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/Font.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_TRUNCATE_END</code></td></tr><tr><td><code class="constant">B_TRUNCATE_BEGINNING</code></td></tr><tr><td><code class="constant">B_TRUNCATE_MIDDLE</code></td></tr><tr><td><code class="constant">B_TRUNCATE_SMART</code></td></tr></tbody></table></div><p>
These constants instruct a
<a class="link" href="BFont.html" title="BFont"><code class="classname">BFont</code></a>
where it should remove characters from a set of strings to shorten them.
</p><p>
See also:
<a class="link" href="BFont.html#BFont_GetTruncatedStrings" title="GetTruncatedStrings(), TruncateString()"><code class="methodname">BFont::GetTruncatedStrings()</code></a>
</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="Constants_tint_color"></a>tint_color() Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_LIGHTEN_MAX_TINT</code></td><td>The maximum amount of tinting lighter. A color component value of 216 will become 255.</td></tr><tr><td><code class="constant">B_LIGHTEN_2_TINT</code></td><td>The second largest amount of lightening. A color
component value of 216 will become 240.</td></tr><tr><td><code class="constant">B_LIGHTEN_1_TINT</code></td><td>A small amount of lightening. A color component value of
216 will become 232.</td></tr><tr><td><code class="constant">B_NO_TINT</code></td><td>Has no effect on the color.</td></tr><tr><td><code class="constant">B_DARKEN_1_TINT</code></td><td>The least amount of darkening. A color component value of
184 will become zero.</td></tr><tr><td><code class="constant">B_DARKEN_2_TINT</code></td><td>Darker. A color component value of 216 will become 152.</td></tr><tr><td><code class="constant">B_DARKEN_3_TINT</code></td><td>Even darker. A color component value of 216 will become
128.</td></tr><tr><td><code class="constant">B_DARKEN_4_TINT</code></td><td>Darker still A color component value of 216 will become
96.</td></tr><tr><td><code class="constant">B_DARKEN_MAX_TINT</code></td><td>Wow, that's really dark. A color component value of 216
will become zero.</td></tr><tr><td><code class="constant">B_DISABLED_LABEL_TINT</code></td><td>Use this constant when generating colors with which
to disable text labels.</td></tr><tr><td><code class="constant">B_HIGHLIGHT_BACKGROUND_TINT</code></td><td>Use this constant to create a dark color for
use as a background color on selected data.</td></tr><tr><td><code class="constant">B_DISABLED_MARK_TINT</code></td><td>Use this to create a color for a disabled checkmark
or radio button mark (or other tick-mark type items).</td></tr></tbody></table></div><p>
These constants are used when calling
<a class="link" href="TheInterfaceKit_Functions.html#tint_color" title="tint_color()"><code class="function">tint_color()</code></a>
to alter an existing color, especially for creating disabled objects or highlighting
backgrounds.
</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="Constants_Transparency"></a>Transparency Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/GraphicsDefs.h</code>
</p><pre class="programlisting">const <span class="type">uint8</span> <code class="constant">B_TRANSPARENT_8_BIT</code>
const <span class="type">rgb_color</span> <code class="constant">B_TRANSPARENT_32_BIT</code></pre><p>
These constants set transparent pixel values in a bitmap image.
<code class="constant">B_TRANSPARENT_8_BIT</code> designates a transparent pixel in the <code class="constant">B_CMAP8</code> color
space, and <code class="constant">B_TRANSPARENT_32_BIT</code> designates a transparent pixel in the
<code class="constant">B_RGB32</code> color space.
</p><p>
Transparency is explained in the "Drawing Modes" part of the "Drawing"
section of this chapter. Drawing modes other than B_OP_COPY preserve the
destination image where a source bitmap is transparent.
</p><p>
See also:
"<a class="xref" href="TheInterfaceKit_Drawing.html#TheInterfaceKit_Drawing_Drawing_Modes" title="Drawing Modes">Drawing Modes</a>" in the
"<a class="xref" href="TheInterfaceKit_Drawing.html" title="Drawing">Drawing</a>" section of this chapter, the
<a class="link" href="BBitmap.html" title="BBitmap"><code class="classname">BBitmap</code></a> class,
<a class="link" href="BView.html#BView_SetViewColor" title="SetViewColor(), ViewColor()"><code class="methodname">BView::SetViewColor()</code></a>
</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="color_which"></a>color_which Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_PANEL_BACKGROUND_COLOR</code></td><td>The background color used for view panels.</td></tr><tr><td><code class="constant">B_MENU_BACKGROUND_COLOR</code></td><td>The background color used for menus.</td></tr><tr><td><code class="constant">B_MENU_SELECTION_BACKGROUND_COLOR</code></td><td>The color used for highlighting menu
items when selected.</td></tr><tr><td><code class="constant">B_MENU_ITEM_TEXT_COLOR</code></td><td>The color used for drawing menu item labels when
not selected.</td></tr><tr><td><code class="constant">B_MENU_SELECTED_ITEM_TEXT_COLOR</code></td><td>The color used for drawing menu item
labels when selected.</td></tr><tr><td><code class="constant">B_WINDOW_TAB_COLOR</code></td><td>The color used to draw the window's title tab.</td></tr><tr><td><code class="constant">B_KEYBOARD_NAVIGATION_COLOR</code></td><td>The color used to draw the mark indicating
which control is focused for keyboard navigation.</td></tr><tr><td><code class="constant">B_DESKTOP_COLOR</code></td><td>The current desktop color.</td></tr></tbody></table></div><p>
When calling <a class="link" href="TheInterfaceKit_Functions.html#ui_color" title="ui_color()"><code class="function">ui_color()</code></a>
to obtain the color for a user interface element,
these constants are used to select the desired element.
</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="Constants_View_Flags"></a>View Flags</h3></div></div></div><p>
Declared in: <code class="filename">interface/View.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_FULL_UPDATE_ON_RESIZE</code></td><td>Include the entire view in the clipping region.</td></tr><tr><td><code class="constant">B_WILL_DRAW</code></td><td>Allow the <code class="classname">BView</code> to draw.</td></tr><tr><td><code class="constant">B_PULSE_NEEDED</code></td><td>Report pulse events to the <code class="classname">BView</code>.</td></tr><tr><td><code class="constant">B_FRAME_EVENTS</code></td><td>Report view-resized and view-moved events.</td></tr><tr><td><code class="constant">B_NAVIGABLE</code></td><td>Let users navigate to the view with the <span class="keycap">Tab</span> key.</td></tr><tr><td><code class="constant">B_NAVIGABLE_JUMP</code></td><td>Mark the view for <span class="keycap">Control</span>+<span class="keycap">Tab</span> navigation.</td></tr></tbody></table></div><p>
These constants can be combined to form a mask that sets the behavior of
a <a class="link" href="BView.html" title="BView"><code class="classname">BView</code></a> object. They're explained in more detail under the class
constructor. The mask is passed to the <a class="link" href="BView.html#BView_Constructor" title="BView()">constructor</a>, or to the
<a class="link" href="BView.html#BView_SetFlags" title="SetFlags() , Flags()"><code class="methodname">SetFlags()</code></a>
function.
</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="Constants_Window_Flags"></a>Window Flags</h3></div></div></div><p>
Declared in: <code class="filename">interface/Window.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_NOT_MOVABLE B_NOT_CLOSABLE</code></td></tr><tr><td><code class="constant">B_NOT_H_RESIZABLE</code></td></tr><tr><td><code class="constant">B_NOT_ZOOMABLE</code></td></tr><tr><td><code class="constant">B_NOT_V_RESIZABLE</code></td></tr><tr><td><code class="constant">B_NOT_MINIMIZABLE</code></td></tr><tr><td><code class="constant">B_NOT_RESIZABLE</code></td></tr><tr><td><code class="constant">B_WILL_FLOAT</code></td></tr><tr><td><code class="constant">B_WILL_ACCEPT_FIRST_CLICK</code></td></tr></tbody></table></div><p>
These constants set the behavior of a window. They can be combined to
form a mask that's passed to the <code class="classname">BWindow</code>
<a class="link" href="BWindow.html#BWindow_Constructor" title="BWindow()">constructor</a>.
</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="Constants_window_type"></a>window_type Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/Window.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><code class="constant">B_MODAL_WINDOW</code></td><td>The window is a modal window.</td></tr><tr><td><code class="constant">B_BORDERED_WINDOW</code></td><td>The window has a border but no title tab.</td></tr><tr><td><code class="constant">B_TITLED_WINDOW</code></td><td>The window has a border and a title tab.</td></tr><tr><td><code class="constant">B_DOCUMENT_WINDOW</code></td><td>The window has a border, tab and resize knob.</td></tr></tbody></table></div><p>
These constants describe the various kinds of windows that can be
requested from the Application Server.
</p><p>
See also:
The <code class="classname">BWindow</code> <a class="link" href="BWindow.html#BWindow_Constructor" title="BWindow()">constructor</a>
</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="Constants_Workspace"></a>Workspace Constants</h3></div></div></div><p>
Declared in: <code class="filename">interface/Window.h</code>
</p><div class="informaltable"><table border="1"><colgroup><col /></colgroup><thead><tr><th>Constant</th></tr></thead><tbody><tr><td><code class="constant">B_CURRENT_WORKSPACE</code></td></tr><tr><td><code class="constant">B_ALL_WORKSPACES</code></td></tr></tbody></table></div><p>
These constants are used—along with designations of specific
workspaces—to associate a set of one or more workspaces with a
<a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a>.
</p><p>
See also:
The <code class="classname">BWindow</code> <a class="link" href="BWindow.html#BWindow_Constructor" title="BWindow()">constructor</a>,
<a class="link" href="BWindow.html#BWindow_SetWorkspaces" title="SetWorkspaces(), Workspaces()"><code class="methodname">BWindow::SetWorkspaces()</code></a>
</p></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="TheInterfaceKit_Functions.html">Functions</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="TheInterfaceKit_MessageConstants.html">Message Constants</a> </div><div id="footerB"><div id="footerBL"><a href="TheInterfaceKit_Functions.html" title="Functions"><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_MessageConstants.html" title="Message Constants"><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