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

329 lines
32 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_MessageConstants.html" title="Message Constants" /><link rel="next" href="TheKernelKit.html" title="The Kernel Kit" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="TheInterfaceKit_MessageConstants.html" title="Message 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="TheKernelKit.html" title="The Kernel Kit"><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_MessageConstants.html">Message Constants</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="TheKernelKit.html">The Kernel Kit</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_DefinedTypes"></a>Defined Types</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="button_width"></a>button_width</h3></div></div></div><a id="id1096840" class="indexterm"></a><p>Declared in: <code class="filename">interface/Alert.h</code></p><pre class="programlisting definition c">enum <span class="type">button_width</span> {
<code class="constant">B_WIDTH_AS_USUAL</code>,
<code class="constant">B_WIDTH_FROM_LABEL</code>,
<code class="constant">B_WIDTH_FROM_WIDEST</code></pre><p>These constants name the methods that can be used to determine how wide
to make the buttons in an alert panel.</p><p>See also:
<a class="link" href="TheInterfaceKit_GeneralConstants.html#alignment" title="alignment Constants">button_width Constants</a>,
the <code class="classname">BAlert</code>
<a class="link" href="BAlert.html#BAlert_Constructor" title="BAlert()">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="color_map"></a>color_map</h3></div></div></div><a id="id1096914" class="indexterm"></a><p>Declared in: <code class="filename">interface/GraphicsDefs.h</code></p><pre class="programlisting cpp">typedef struct {
<span class="type">int32</span> <code class="varname">id</code>;
<span class="type">rgb_color</span> <code class="varname">color_list</code>[256];
<span class="type">uint8</span> <code class="varname">inversion_map</code>[256];
<span class="type">uint8</span> <code class="varname">index_map</code>[32768];
} <span class="type">color_map</span></pre><p>This structure contains information about the 8-bit color context for a
particular screen. All applications that display on the screen share the
same color map.</p><p>See also:
<a class="link" href="BScreen.html#BScreen_ColorMap" title="ColorMap(), IndexForColor(), ColorForIndex()"><code class="methodname">BScreen::ColorMap()</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="edge_info"></a>edge_info</h3></div></div></div><a id="id1096996" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Font.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">float</span> <code class="varname">left</code>;
<span class="type">float</span> <code class="varname">right</code>;
} <span class="type">edge_info</span></pre><p>
This structure records information about the location of a character
outline within the horizontal space allotted to the character. Edges
separate one character from adjacent characters on the left and right.
They're explained under the
<a class="link" href="BFont.html#BFont_GetEdges"><code class="methodname">GetEdges()</code></a> function in
the <a class="link" href="BFont.html" title="BFont"><code class="classname">BFont</code></a> class.
</p><p>
See also:
<a class="link" href="BFont.html#BFont_GetEscapements" title="GetEscapements(), escapement_delta, GetEdges(), edge_info"><code class="methodname">BFont::GetEscapements()</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="escapement_delta"></a>escapement_delta</h3></div></div></div><a id="id1097081" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Font.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">float</span> <code class="varname">nonspace</code>;
<span class="type">float</span> <code class="varname">space</code>;
} <span class="type">escapement_delta</span></pre><p>
This structure contains values that should be added to the width of each
character in a string when the string is drawn.
</p><p>
See also:
<a class="link" href="BView.html#BView_DrawString" title="DrawString()"><code class="methodname">BView::DrawString(),</code></a>
<a class="link" href="BFont.html#BFont_GetEscapements" title="GetEscapements(), escapement_delta, GetEdges(), edge_info"><code class="methodname">BFont::GetEscapements()</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="font_family"></a>font_family</h3></div></div></div><a id="id1097158" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef <span class="type">char</span> <span class="type">font_family</span>[<code class="constant">B_FONT_FAMILY_LENGTH</code> + 1]</pre><p>
This type defines a string long enough to hold the name of a font
family—64 characters including the null terminator.
</p><p>
See also:
<a class="link" href="TheInterfaceKit_Functions.html#get_font_family" title="get_font_family(), count_font_families(), get_font_style(), count_font_styles()"><code class="function">get_font_family()</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="font_height"></a>font_height</h3></div></div></div><a id="id1097220" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Font.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">float</span> <code class="varname">ascent</code>;
<span class="type">float</span> <code class="varname">descent</code>;
<span class="type">float</span> <code class="varname">leading</code>;
} <span class="type">font_height</span></pre><p>
This type combines the three vertical measurements that determine the
height of a line of text.
</p><p>
See also:
<a class="link" href="BFont.html#BFont_GetHeight" title="GetHeight(), font_height"><code class="methodname">BFont::GetHeight()</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="font_style"></a>font_style</h3></div></div></div><a id="id1097296" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef <span class="type">char</span> <span class="type">font_style</span>[<code class="constant">B_FONT_STYLE_LENGTH</code> + 1]</pre><p>
This type defines a string long enough to hold the name of a font
style—64 characters including the null terminator.
</p><p>
See also:
<a class="link" href="TheInterfaceKit_Functions.html#get_font_style"><code class="function">get_font_style()</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="key_info"></a>key_info</h3></div></div></div><a id="id1097358" class="indexterm"></a><p>
Declared in: <code class="filename">interface/View.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">uint32</span> <code class="varname">modifiers</code>;
<span class="type">uint8</span> <code class="varname">key_states</code>[16];
} <span class="type">key_info</span></pre><p>
This structure is used to get information about the current state of the
keyboard in the absence of <code class="constant">B_KEY_DOWN</code> messages.
</p><p>
See also:
<a class="link" href="TheInputServer_Functions.html#get_key_info" title="get_key_info()"><code class="function">get_key_info()</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="key_map"></a>key_map</h3></div></div></div><a id="id1097430" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">uint32</span> <code class="varname">version</code>;
<span class="type">uint32</span> <code class="varname">caps_key</code>;
<span class="type">uint32</span> <code class="varname">scroll_key</code>;
<span class="type">uint32</span> <code class="varname">num_key</code>;
<span class="type">uint32</span> <code class="varname">left_shift_key</code>;
<span class="type">uint32</span> <code class="varname">right_shift_key</code>;
<span class="type">uint32</span> <code class="varname">left_command_key</code>;
<span class="type">uint32</span> <code class="varname">right_command_key</code>;
<span class="type">uint32</span> <code class="varname">left_control_key</code>;
<span class="type">uint32</span> <code class="varname">right_control_key</code>;
<span class="type">uint32</span> <code class="varname">left_option_key</code>;
<span class="type">uint32</span> <code class="varname">right_option_key</code>;
<span class="type">uint32</span> <code class="varname">menu_key</code>;
<span class="type">uint32</span> <code class="varname">lock_settings</code>;
<span class="type">int32</span> <code class="varname">control_map</code>[128];
<span class="type">int32</span> <code class="varname">option_caps_shift_map</code>[128];
<span class="type">int32</span> <code class="varname">option_caps_map</code>[128];
<span class="type">int32</span> <code class="varname">option_shift_map</code>[128];
<span class="type">int32</span> <code class="varname">option_map</code>[128];
<span class="type">int32</span> <code class="varname">caps_shift_map</code>[128];
<span class="type">int32</span> <code class="varname">caps_map</code>[128];
<span class="type">int32</span> <code class="varname">shift_map</code>[128];
<span class="type">int32</span> <code class="varname">normal_map</code>[128];
<span class="type">int32</span> <code class="varname">acute_dead_key</code>[32];
<span class="type">int32</span> <code class="varname">grave_dead_key</code>[32];
<span class="type">int32</span> <code class="varname">circumflex_dead_key</code>[32];
<span class="type">int32</span> <code class="varname">dieresis_dead_key</code>[32];
<span class="type">int32</span> <code class="varname">tilde_dead_key</code>[32];
<span class="type">uint32</span> <code class="varname">acute_tables</code>;
<span class="type">uint32</span> <code class="varname">grave_tables</code>;
<span class="type">uint32</span> <code class="varname">circumflex_tables</code>;
<span class="type">uint32</span> <code class="varname">dieresis_tables</code>;
<span class="type">uint32</span> <code class="varname">tilde_tables</code>;
} <span class="type">key_map</span></pre><p>
This structure maps the physical keys on the keyboard to their functions
in the user interface. It holds the tables that assign characters to key
codes, set up dead keys, and determine which keys function as modifiers.
There's just one key map shared by all applications running on the same
machine.
</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="menu_bar_border"></a>menu_bar_border</h3></div></div></div><a id="id1097735" class="indexterm"></a><p>
Declared in: <code class="filename">interface/MenuBar.h</code>
</p><pre class="programlisting cpp">typedef enum {. . .} <span class="type">menu_bar_border</span></pre><p>
This type enumerates the ways that a menu bar can be bordered.
</p><p>
See also:
<a class="link" href="BMenuBar.html#BMenuBar_SetBorder" title="SetBorder(), Border()"><code class="methodname">BMenuBar::SetBorder()</code></a>,
"<a class="link" href="TheInterfaceKit_DefinedTypes.html#menu_bar_border" title="menu_bar_border">menu_bar_border Constants</a>" above
</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="menu_info"></a>menu_info</h3></div></div></div><a id="id1097794" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Menu.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">float</span> <code class="varname">font_size</code>;
<span class="type">font_name</span> <code class="varname">font</code>;
<span class="type">rgb_color</span> <code class="varname">background_color</code>;
<span class="type">int32</span> <code class="varname">separator</code>;
<span class="type">bool</span> <code class="varname">click_to_open</code>;
<span class="type">bool</span> <code class="varname">triggers_always_shown</code>;
} <span class="type">menu_info</span></pre><p>
This structure records the user's menu preferences.
</p><p>
See also:
<a class="link" href="TheInterfaceKit_Functions.html#set_menu_info" title="set_menu_info(), get_menu_info()"><code class="function">set_menu_info()</code></a>,
the <a class="link" href="BMenu.html" title="BMenu"><code class="classname">BMenu</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="menu_layout"></a>menu_layout</h3></div></div></div><a id="id1097899" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Menu.h</code>
</p><pre class="programlisting cpp">typedef enum {. . .} <span class="type">menu_layout</span></pre><p>
This type distinguishes the various ways that items can arranged in a
menu or menu bar.
</p><p>
See also:
The <a class="link" href="BMenu.html" title="BMenu"><code class="classname">BMenu</code></a> class,
"<a class="link" href="TheInterfaceKit_DefinedTypes.html#menu_layout" title="menu_layout">menu_layout Constants</a>" above
</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="mouse_map"></a>mouse_map</h3></div></div></div><a id="id1097958" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">uint32</span> <code class="varname">left</code>;
<span class="type">uint32</span> <code class="varname">right</code>;
<span class="type">uint32</span> <code class="varname">middle</code>;
} <span class="type">mouse_map</span></pre><p>
This structure maps mouse buttons to their roles as the
<code class="constant">B_PRIMARY_MOUSE_BUTTON</code>, <code class="constant">B_SECONDARY_MOUSE_BUTTON</code>, or
<code class="constant">B_TERTIARY_MOUSE_BUTTON</code>.
</p><p>
See also:
<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="orientation"></a>orientation</h3></div></div></div><a id="id1098045" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef enum {. . .} <span class="type">orientation</span></pre><p>
This type distinguishes between the <code class="constant">B_VERTICAL</code> and <code class="constant">B_HORIZONTAL</code>
orientation of 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="pattern"></a>pattern</h3></div></div></div><a id="id1098111" class="indexterm"></a><p>
Declared in: <code class="filename">interface/GraphicsDefs.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">uchar</span> <code class="varname">data</code>[8];
} <span class="type">pattern</span></pre><p>
A pattern is a arrangement of two colors—the high color and the low
color—in an 8-pixel by 8-pixel square. Pixels are specified in
rows, with one byte per row and one bit per pixel. Bits marked 1
designate the high color; those marked 0 designate the low color. An
example and an illustration are given under "Patterns" in the "Drawing
section of this chapter.
</p><p>
See also:
"<a class="link" href="TheInterfaceKit_GeneralConstants.html#Constants_Pattern" title="Pattern Constants">Pattern Constants</a>" above
</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="print_file_header"></a>print_file_header</h3></div></div></div><a id="id1098176" class="indexterm"></a><p>
Declared in: <code class="filename">interface/PrintJob.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">long</span> <code class="varname">version</code>;
<span class="type">long</span> <code class="varname">page_count</code>;
<span class="type">long</span> <code class="varname">_reserved_1_</code>;
<span class="type">long</span> <code class="varname">_reserved_2_</code>;
<span class="type">long</span> <code class="varname">_reserved_3_</code>;
<span class="type">long</span> <code class="varname">_reserved_4_</code>;
<span class="type">long</span> <code class="varname">_reserved_5_</code>;
} <span class="type">print_file_header</span></pre><p>
This structure defines the header information for a print job. Although
declared publicly, it currently is used only internally by the
<a class="link" href="BPrintJob.html" title="BPrintJob"><code class="classname">BPrintJob</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="rgb_color"></a>rgb_color</h3></div></div></div><a id="id1098279" class="indexterm"></a><p>
Declared in: <code class="filename">interface/GraphicsDefs.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">uint8</span> <code class="varname">red</code>;
<span class="type">uint8</span> <code class="varname">green</code>;
<span class="type">uint8</span> <code class="varname">blue</code>;
<span class="type">uint8</span> <code class="varname">alpha</code>;
} <span class="type">rgb_color</span></pre><p>
This type specifies a full 32-bit color. Each component can have a value
ranging from a minimum of 0 to a maximum of 255.
</p><p>
The alpha component, which is designed to specify the coverage of the
color (how transparent or opaque it is), is currently ignored. However,
an rgb_color can be made completely transparent by assigning it the
special value, <code class="constant">B_TRANSPARENT_32_BIT</code>.
</p><p>
See also:
<a class="link" href="BView.html#BView_SetHighColor" title="SetHighColor(), HighColor() , SetLowColor() , LowColor()"><code class="methodname">BView::SetHighColor()</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="screen_id"></a>screen_id</h3></div></div></div><a id="id1098374" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Screen.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">int32</span> <code class="varname">id</code>;
} <span class="type">screen_id</span></pre><p>
This type is a unique identifier for a screen. The constant
<code class="constant">B_MAIN_SCREEN_ID</code> is a <span class="type">screen_id</span>
that identifies the main screen.</p><p>
See also:
The <a class="link" href="BScreen.html" title="BScreen"><code class="classname">BScreen</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="screen_info"></a>screen_info</h3></div></div></div><a id="id1098442" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">color_space</span> <code class="varname">mode</code>;
<code class="classname">BRect</code> <code class="varname">frame</code>;
<span class="type">uint32</span> <code class="varname">spaces</code>;
<span class="type">float</span> <code class="varname">min_refresh_rate</code>;
<span class="type">float</span> <code class="varname">max_refresh_rate</code>;
<span class="type">float</span> <code class="varname">refresh_rate</code>;
<span class="type">uchar</span> <code class="varname">h_position</code>;
<span class="type">uchar</span> <code class="varname">v_position</code>;
<span class="type">uchar</span> <code class="varname">h_size</code>;
<span class="type">uchar</span> <code class="varname">v_size</code>;
} <span class="type">screen_info</span></pre><p>
This structure holds information about a screen. Its fields are explained
under the
<code class="function">get_screen_info()</code>
global 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="scroll_bar_info"></a>scroll_bar_info</h3></div></div></div><a id="id1098564" class="indexterm"></a><p>
Declared in: <code class="filename">interface/InterfaceDefs.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">bool</span> <code class="varname">proportional</code>;
<span class="type">bool</span> <code class="varname">double_arrows</code>;
<span class="type">int32</span> <code class="varname">knob</code>;
<span class="type">int32</span> <code class="varname">min_knob_size</code>;
} <span class="type">scroll_bar_info</span></pre><p>
This structure captures the user's preferences for how scroll bars should
behave and appear.
</p><p>
See also:
<a class="link" href="TheInterfaceKit_Functions.html#set_scroll_bar_info" title="set_scroll_bar_info(), get_scroll_bar_info()"><code class="function">set_scroll_bar_info()</code></a>,
the <a class="link" href="BScrollBar.html" title="BScrollBar"><code class="classname">BScrollBar</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="text_run"></a>text_run</h3></div></div></div><a id="id1098654" class="indexterm"></a><p>
Declared in: <code class="filename">interface/TextView.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">int32</span> <code class="varname">offset</code>;
<code class="classname">BFont</code> <code class="varname">font</code>;
<span class="type">rgb_color</span> <code class="varname">color</code>;
} <span class="type">text_run</span></pre><p>
The <a class="link" href="BTextView.html" title="BTextView"><code class="classname">BTextView</code></a>
class uses this structure to keep track of a sequence of
characters that are displayed in the same font and color.
</p><p>
See also:
<a class="link" href="BTextView.html#BTextView_SetRunArray" title="SetRunArray(), RunArray()"><code class="methodname">BTextView::SetRunArray()</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="text_run_array"></a>text_run_array</h3></div></div></div><a id="id1098737" class="indexterm"></a><p>
Declared in: <code class="filename">interface/TextView.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">int32</span> <code class="varname">count</code>;
<span class="type">text_run</span> <code class="varname">runs</code>[];
} <span class="type">text_run_array</span></pre><p>
The <a class="link" href="BTextView.html" title="BTextView"><code class="classname">BTextView</code></a>
class uses this structure to associate character formats
with the text it displays.
</p><p>
See also:
<a class="link" href="BTextView.html#BTextView_SetRunArray" title="SetRunArray(), RunArray()"><code class="methodname">BTextView::SetRunArray()</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="tuned_font_info"></a>tuned_font_info</h3></div></div></div><a id="id1098812" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Font.h</code>
</p><pre class="programlisting cpp">typedef struct {
<span class="type">float</span> <code class="varname">size</code>;
<span class="type">float</span> <code class="varname">shear</code>;
<span class="type">float</span> <code class="varname">rotation</code>;
<span class="type">int32</span> <code class="varname">flags</code>;
<span class="type">int16</span> <code class="varname">face</code>;
} <span class="type">tuned_font_info</span></pre><p>
This structure lists the properties of a font that has a counterpart
that's been tuned to improve its appearance on-screen. The tuned
counterpart will be used whenever the font is the
<a class="link" href="BView.html" title="BView"><code class="classname">BView</code></a>'s current font
and <a class="link" href="BView.html#BView_DrawString" title="DrawString()"><code class="methodname">DrawString()</code></a> draws to the screen.
</p><p>
See also:
<a class="link" href="BFont.html#BFont_GetTunedInfo" title="GetTunedInfo(), CountTuned(), tuned_font_info"><code class="methodname">BFont::GetTunedInfo()</code></a>,
<a class="link" href="TheInterfaceKit_Functions.html#get_font_family" title="get_font_family(), count_font_families(), get_font_style(), count_font_styles()"><code class="function">get_font_family()</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="window_type"></a>window_type</h3></div></div></div><a id="id1098926" class="indexterm"></a><p>
Declared in: <code class="filename">interface/Window.h</code>
</p><pre class="programlisting cpp">typedef enum {. . .} <span class="type">window_type</span></pre><p>
This type describes the various kinds of windows that can be requested
from the Application Server.
</p><p>
See also:
The <a class="link" href="BWindow.html" title="BWindow"><code class="classname">BWindow</code></a> constructor,
"<a class="link" href="TheInterfaceKit_DefinedTypes.html#window_type" title="window_type">window_type Constants</a>"
</p></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="TheInterfaceKit_MessageConstants.html">Message Constants</a>  Up: <a href="TheInterfaceKit.html">The Interface Kit</a>  Next: <a href="TheKernelKit.html">The Kernel Kit</a> </div><div id="footerB"><div id="footerBL"><a href="TheInterfaceKit_MessageConstants.html" title="Message 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="TheKernelKit.html" title="The Kernel Kit"><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