os Namespace Reference

os:: This namespace wrapps all AtheOS API classes More...

Classes
struct	RowPosPred
class	ListViewCol
class	ListViewHeader
class	ListViewContainer
class	DummyRow
class	MenuWindow
class	TextEdit
class	Application
	Singleton class representing an application. More...
class	AppserverConfig
class	Catalog
	String Catalog. More...
class	LString
	Localised String. More...
class	CircularBuffer
	Circular (FIFO) data container. More...
class	Clipboard
	Description: A clipboard allows a user to save data that is "Cut" or "Copied" from an application. More...
class	DateTime
	Abstract datatype for date and time. More...
class	Event
	Events. More...
class	errno_exception
class	Flattenable
	Description: The os::Flattenable class defines an interface for "flattening" objects. More...
class	Handler
class	Invoker
	Description: More...
class	Locale
	Locale class. More...
class	Locker
	Description: More...
class	AutoLocker
	Description: More...
class	Gate
	Description: More...
class	Looper
	Description: More...
class	Message
	Description: The os::Message is the heart of the messaging system in AtheOS. More...
class	MessageFilter
	Description: More...
class	MessageQueue
	Description: More...
class	Messenger
	Description: More...
class	OptionParser
	Command line option parser. More...
class	RegExp
	Regular expression class. More...
class	ResStream
	Data stream helper class for os::Resources. More...
class	Resources
	Helper class for reading/writing resources embedded in executables and DLL's. More...
class	Settings
	Utility class for storage of user settings and preferences. More...
class	ShortcutKey
class	String
	String manipulation class. More...
class	Thread
	Thread class. More...
class	Variant
class	Bitmap
	Container for bitmap-image data. More...
class	Button
	Simple push-button class. More...
class	CheckBox
	2-state check box. More...
class	CheckMenu
	Description: A menuitem which can either be "On" or "Off" More...
class	ColorRequester
	Color Requester. More...
class	ColorSelector
	ColorSelector. More...
class	Control
	Base class for GUI controls. More...
class	Desktop
class	FileRow
	Directory browser control. More...
class	DirectoryView
	Directory view suitable for file-requesters and other file browsers. More...
class	DropdownMenu
	Edit box with an asociated item-menu. More...
class	FileFilter
class	FileRequester
	Generic file requester. More...
struct	font_height
struct	font_attribs
struct	edge_info
struct	font_properties
class	Font
	Text Font class. More...
class	FontRequester
	Font Requester. More...
class	FrameView
	Description: A view with a border surrounding it, and an optional title. More...
struct	Color32_s
	Colour datatype. More...
class	DirectoryIconData
class	IconDirectoryView
	Directory view suitable for file-requesters and other file browsers. More...
class	IconData
class	IconView
	Icon view with different views. More...
class	Image
	Container for image data. More...
class	BitmapImage
	Container for bitmap image data. More...
class	ColorizeFilter
class	GlowFilter
class	ImageButton
	Imagebutton gui element. More...
class	ImageView
	View class for Image objects. More...
class	InputBox
	Simple InputBox class. More...
class	KeyboardEvent
class	LayoutNode
	Layout node. More...
class	LayoutSpacer
	Layout spacer. More...
class	VLayoutSpacer
	Vertical layout spacer. More...
class	HLayoutSpacer
	Horizontal layout spacer. More...
class	HLayoutNode
	Horizontal Layout class. More...
class	VLayoutNode
	Vertical Layout class. More...
class	LayoutView
	Main class in the Syllable dynamic layout system. More...
class	ListViewRow
	Description: More...
class	ListViewStringRow
	Description: More...
class	ListView
	Flexible multicolumn list view. More...
class	MenuItem
	Menu item class. More...
class	MenuSeparator
	Menu separator item. More...
class	Menu
	The menuing system for Syllable. More...
class	Point
	Description: More...
class	IPoint
	Description: More...
class	PopupMenu
	Popupmenu gui element. More...
class	RadioButton
	Description: More...
class	Rect
	Description: More...
class	IRect
	Description: More...
struct	ClipRect
	Description: More...
class	ClipRectList
	Description: More...
class	Region
	Description: More...
class	AlertView
class	Alert
	Description: More...
class	ProgressView
class	ProgressRequester
class	ScrollBar
	Description: The os::ScrollBar is one object that is used in a lot of other GUI elements. More...
class	Separator
	Separator bar. More...
class	Slider
	Description: More...
class	Spinner
	Description: More...
class	Splitter
	Splitter View. More...
class	Sprite
class	StatusPanel
	Base class for StatusBar panels. More...
class	StatusBar
	Status bar. More...
class	StringView
	Description: Display a non-editable text string (text label)- More...
class	TableCell
class	TableView
class	TabViewTab
class	TabView
	Description: More...
class	TextView
	Description: More...
class	ToolBar
	ToolBar. More...
class	TreeViewNode
	Baseclass for TreeView nodes. More...
class	TreeViewStringNode
	TreeView node containing strings. More...
class	TreeView
	Flexible multicolumn tree view. More...
class	View
	Base class for all GUI components. More...
class	Window
	Description: More...
class	Directory
	Filesystem directory class. More...
class	DirIterator
	Description: More...
class	File
	Description: More...
class	FileReference
	Semi persistent reference to a file. More...
class	FSNode
	Lowlevel filesystem node class. More...
class	MemFile
	Virtual stream object. More...
class	NodeMonitor
	Filesystem node monitor. More...
class	Path
	Description: More...
class	RegistrarFileType
	Class to access a filetype. More...
class	RegistrarAppList
	Class to access the application list. More...
class	RegistrarManager
	Class to access the registrar server. More...
class	SeekableIO
	Description: More...
class	StreamableIO
	Description: More...
class	SymLink
	Symbolic link handling class. More...
class	TempFile
	Description: More...
class	Volumes
	Information about the mounted volumes. More...
struct	BitmapHeader
struct	BitmapFrameHeader
class	DataReceiver
class	Translator
struct	TranslatorInfo
class	TranslatorNode
class	TranslatorFactory
Typedefs
typedef std::list< MessageFilter * >	MsgFilterList
	Description:
typedef errno_exception	ThreadException
typedef Color32_s	Color32
Enumerations
enum	{   BMID_ARROW_LEFT,   BMID_ARROW_RIGHT,   BMID_ARROW_UP,   BMID_ARROW_DOWN,   BMID_COUNT }
enum	MessageFilterResult {   MF_DISPATCH_MESSAGE = 0,   MF_DISCARD_MESSAGE = 1 }
enum	type_code {   T_ANY_TYPE,   T_POINTER,   T_INT8,   T_INT16,   T_INT32,   T_INT64,   T_BOOL,   T_FLOAT,   T_DOUBLE,   T_STRING,   T_IRECT,   T_IPOINT,   T_MESSAGE,   T_COLOR32,   T_FILE,   T_MEM_OBJ,   T_RECT,   T_POINT,   T_VARIANT,   T_RAW,   T_SHORTCUTKEY,   T_FONT,   T_DATETIME,   T_USER = 0x80000000 }
	More...
enum	font_spacing {   CHAR_SPACING,   STRING_SPACING,   FIXED_SPACING }
enum	font_direction {   FONT_LEFT_TO_RIGHT,   FONT_RIGHT_TO_LEFT,   FONT_TOP_TO_BOTTOM,   FONT_BOTTOM_TO_TOP }
enum	{   TRUNCATE_END = 0,   TRUNCATE_BEGINNING = 1,   TRUNCATE_MIDDLE = 2,   TRUNCATE_SMART = 3 }
enum	{   UNICODE_UTF8,   ISO_8859_1,   ISO_8859_2,   ISO_8859_3,   ISO_8859_4,   ISO_8859_5,   ISO_8859_6,   ISO_8859_7,   ISO_8859_8,   ISO_8859_9,   ISO_8859_10,   MACINTOSH_ROMAN }
enum	{   FONT_IS_FIXED = 0x0001,   FONT_HAS_TUNED_SIZES = 0x0002,   FONT_IS_SCALABLE = 0x0004 }
enum	{   FPF_MONOSPACED = 0x00000001,   FPF_SMOOTHED = 0x00000002,   FPF_BOLD = 0x00000004,   FPF_ITALIC = 0x00000008,   FPF_SYSTEM = 0x80000000 }
enum	MenuLayout_e {   ITEMS_IN_COLUMN,   ITEMS_IN_ROW,   ITEMS_CUSTOM_LAYOUT }
enum	{ SB_MINSIZE = 12 }
enum	{ SL_MINSIZE = 8 }
enum	default_color_t {   COL_NORMAL,   COL_SHINE,   COL_SHADOW,   COL_SEL_WND_BORDER,   COL_NORMAL_WND_BORDER,   COL_MENU_TEXT,   COL_SEL_MENU_TEXT,   COL_MENU_BACKGROUND,   COL_SEL_MENU_BACKGROUND,   COL_SCROLLBAR_BG,   COL_SCROLLBAR_KNOB,   COL_LISTVIEW_TAB,   COL_LISTVIEW_TAB_TEXT,   COL_ICON_TEXT,   COL_ICON_SELECTED,   COL_ICON_BG,   COL_FOCUS,   COL_COUNT }
enum	{   FRAME_RECESSED = 0x000008,   FRAME_RAISED = 0x000010,   FRAME_THIN = 0x000020,   FRAME_WHIDE = 0x000040,   FRAME_ETCHED = 0x000080,   FRAME_FLAT = 0x000100,   FRAME_DISABLED = 0x000200,   FRAME_TRANSPARENT = 0x010000 }
enum	{   MOUSE_INSIDE,   MOUSE_OUTSIDE,   MOUSE_ENTERED,   MOUSE_EXITED }
enum	tab_order {   NO_TAB_ORDER = -1,   NEXT_TAB_ORDER = -2 }
	Tab order allocation. More...
enum	view_flags {   WID_FULL_UPDATE_ON_H_RESIZE = 0x0001,   WID_FULL_UPDATE_ON_V_RESIZE = 0x0002,   WID_FULL_UPDATE_ON_RESIZE = 0x0003,   WID_WILL_DRAW = 0x0004,   WID_TRANSPARENT = 0x0008,   WID_CLEAR_BACKGROUND = 0x0010,   WID_DRAW_ON_CHILDREN = 0x0020 }
	Flags controlling a View. More...
enum	view_resize_flags {   CF_FOLLOW_NONE = 0x0000,   CF_FOLLOW_LEFT = 0x0001,   CF_FOLLOW_RIGHT = 0x0002,   CF_FOLLOW_TOP = 0x0004,   CF_FOLLOW_BOTTOM = 0x0008,   CF_FOLLOW_ALL = 0x000F,   CF_FOLLOW_H_MIDDLE = 0x0010,   CF_FOLLOW_V_MIDDLE = 0x0020,   CF_FOLLOW_SPECIAL = 0x0040,   CF_FOLLOW_MASK = 0x007f }
	Flags controlling how to resize/move a view when the parent is resized. More...
enum	{   WND_NO_CLOSE_BUT = 0x00000001,   WND_NO_ZOOM_BUT = 0x00000002,   WND_NO_DEPTH_BUT = 0x00000004,   WND_NOT_MOVEABLE = 0x00000008,   WND_NOT_H_RESIZABLE = 0x00000010,   WND_NOT_V_RESIZABLE = 0x00000020,   WND_NOT_RESIZABLE = 0x00000030,   WND_NO_TITLE = 0x00000040,   WND_NO_BORDER = 0x00000080,   WND_FRONTMOST = 0x00000100,   WND_BACKMOST = 0x00000200,   WND_MODAL = 0x00000400,   WND_SEND_WINDOWS_CHANGED = 0x00000800,   WND_SYSTEM = 0x00010000,   WND_SINGLEBUFFER = 0x00020000,   WND_INDEP_DESKTOP_FRAMES = 0x00040000 }
enum	{   CURRENT_DESKTOP = 0,   ALL_DESKTOPS = ~0 }
enum	{   REGISTRAR_OK,   REGISTRAR_ERROR,   REGISTRAR_LOGIN,   REGISTRAR_LOGOUT,   REGISTRAR_INVALIDATE,   REGISTRAR_REGISTER_TYPE,   REGISTRAR_UNREGISTER_TYPE,   REGISTRAR_REGISTER_TYPE_ICON,   REGISTRAR_REGISTER_TYPE_EXTENSION,   REGISTRAR_CLEAR_TYPE_EXTENSIONS,   REGISTRAR_REGISTER_TYPE_HANDLER,   REGISTRAR_CLEAR_TYPE_HANDLERS,   REGISTRAR_GET_TYPE_COUNT,   REGISTRAR_GET_TYPE,   REGISTRAR_SET_DEFAULT_HANDLER,   REGISTRAR_GET_TYPE_AND_ICON,   REGISTRAR_UPDATE_APP_LIST,   REGISTRAR_GET_APP_LIST }
enum	{ BMF_MULTIPASS = 0x0001 }
Functions
Bitmap *	get_std_bitmap (int nBitmap, int nColor, Rect *pcRect)
Color32_s	get_default_color (default_color_t nColor)
	Get the value of one of the standard system colors.
void	__set_default_color (default_color_t nColor, const Color32_s &sColor)
void	set_default_color (default_color_t nColor, const Color32_s &sColor)
void	copy_files (const std::vector< os::String > &cDstPaths, const std::vector< os::String > &cSrcPaths, const Messenger &cMsgTarget, Message *pcFinishMsg, bool bReplace, bool bDontOverwrite)
void	delete_files (const std::vector< os::String > &cPaths, const Messenger &cMsgTarget, Message *pcFinishMsg)
void	move_files (const std::vector< os::String > &cDstPaths, const std::vector< os::String > &cSrcPaths, const Messenger &cMsgTarget, Message *pcFinishMsg, bool bReplace, bool bDontOverwrite)
int	BitsPerPixel (color_space eColorSpc)
uint32	COL_TO_RGB32 (const Color32_s &col)
uint16	COL_TO_RGB16 (const Color32_s &col)
uint16	COL_TO_RGB15 (const Color32_s &col)
Color32_s	RGB32_TO_COL (uint32 pix)
Color32_s	RGB16_TO_COL (uint16 pix)
Color32_s	RGB15_TO_COL (uint16 pix)
Color32_s	RGBA15_TO_COL (uint16 pix)
bool	is_first_utf8_byte (uint8 nByte)
int	utf8_char_length (uint8 nFirstByte)
int	utf8_to_unicode (const char *pzSource)
int	unicode_to_utf8 (char *pzDst, uint32 nChar)
Color32_s	GetStdColor (int i)
Variables
const uint8	__5_to_8_bit_table []
const uint8	__6_to_8_bit_table []

---

Detailed Description

All function and classes defined by the AtheOS API is contained by the 'os' namespace.

Author:

Kurt Skauen ([email protected])

---

Typedef Documentation

typedef Color32_s os::Color32

typedef errno_exception os::ThreadException

---

Enumeration Type Documentation

anonymous enum

Enumerator:

BMID_ARROW_LEFT
BMID_ARROW_RIGHT
BMID_ARROW_UP
BMID_ARROW_DOWN
BMID_COUNT

anonymous enum

Enumerator:

TRUNCATE_END
TRUNCATE_BEGINNING
TRUNCATE_MIDDLE
TRUNCATE_SMART

anonymous enum

Enumerator:

UNICODE_UTF8
ISO_8859_1
ISO_8859_2
ISO_8859_3
ISO_8859_4
ISO_8859_5
ISO_8859_6
ISO_8859_7
ISO_8859_8
ISO_8859_9
ISO_8859_10
MACINTOSH_ROMAN

anonymous enum

Enumerator:

FONT_IS_FIXED
FONT_HAS_TUNED_SIZES
FONT_IS_SCALABLE

anonymous enum

Enumerator:

FPF_MONOSPACED
FPF_SMOOTHED
FPF_BOLD	Antialiased.
FPF_ITALIC
FPF_SYSTEM

anonymous enum

Enumerator:

SB_MINSIZE

anonymous enum

Enumerator:

SL_MINSIZE

anonymous enum

Enumerator:

FRAME_RECESSED
FRAME_RAISED
FRAME_THIN
FRAME_WHIDE
FRAME_ETCHED
FRAME_FLAT
FRAME_DISABLED
FRAME_TRANSPARENT

anonymous enum

Enumerator:

MOUSE_INSIDE
MOUSE_OUTSIDE
MOUSE_ENTERED
MOUSE_EXITED

anonymous enum

Enumerator:

WND_NO_CLOSE_BUT
WND_NO_ZOOM_BUT
WND_NO_DEPTH_BUT
WND_NOT_MOVEABLE
WND_NOT_H_RESIZABLE
WND_NOT_V_RESIZABLE
WND_NOT_RESIZABLE
WND_NO_TITLE
WND_NO_BORDER
WND_FRONTMOST
WND_BACKMOST
WND_MODAL
WND_SEND_WINDOWS_CHANGED
WND_SYSTEM
WND_SINGLEBUFFER
WND_INDEP_DESKTOP_FRAMES

anonymous enum

Enumerator:

CURRENT_DESKTOP
ALL_DESKTOPS

anonymous enum

Enumerator:

REGISTRAR_OK
REGISTRAR_ERROR
REGISTRAR_LOGIN
REGISTRAR_LOGOUT
REGISTRAR_INVALIDATE
REGISTRAR_REGISTER_TYPE
REGISTRAR_UNREGISTER_TYPE
REGISTRAR_REGISTER_TYPE_ICON
REGISTRAR_REGISTER_TYPE_EXTENSION
REGISTRAR_CLEAR_TYPE_EXTENSIONS
REGISTRAR_REGISTER_TYPE_HANDLER
REGISTRAR_CLEAR_TYPE_HANDLERS
REGISTRAR_GET_TYPE_COUNT
REGISTRAR_GET_TYPE
REGISTRAR_SET_DEFAULT_HANDLER
REGISTRAR_GET_TYPE_AND_ICON
REGISTRAR_UPDATE_APP_LIST
REGISTRAR_GET_APP_LIST

anonymous enum

Enumerator:

BMF_MULTIPASS

enum os::default_color_t

Enumerator:

COL_NORMAL
COL_SHINE
COL_SHADOW
COL_SEL_WND_BORDER
COL_NORMAL_WND_BORDER
COL_MENU_TEXT
COL_SEL_MENU_TEXT
COL_MENU_BACKGROUND
COL_SEL_MENU_BACKGROUND
COL_SCROLLBAR_BG
COL_SCROLLBAR_KNOB
COL_LISTVIEW_TAB
COL_LISTVIEW_TAB_TEXT
COL_ICON_TEXT
COL_ICON_SELECTED
COL_ICON_BG
COL_FOCUS
COL_COUNT

enum os::font_direction

Enumerator:

FONT_LEFT_TO_RIGHT
FONT_RIGHT_TO_LEFT
FONT_TOP_TO_BOTTOM
FONT_BOTTOM_TO_TOP

enum os::font_spacing

Enumerator:

CHAR_SPACING
STRING_SPACING
FIXED_SPACING

enum os::MenuLayout_e

Enumerator:

ITEMS_IN_COLUMN
ITEMS_IN_ROW
ITEMS_CUSTOM_LAYOUT

enum os::MessageFilterResult

Enumerator:

MF_DISPATCH_MESSAGE
MF_DISCARD_MESSAGE

enum os::type_code

Description:

Various type codes used to identify data-types by various classes in the toolkit. Most notably the os::Message class and os::Flattenable. For classes not part of the OS namespace, use codes equal to, or higher than, T_USER.

Enumerator:

T_ANY_TYPE
T_POINTER
T_INT8
T_INT16
T_INT32
T_INT64
T_BOOL
T_FLOAT
T_DOUBLE
T_STRING
T_IRECT
T_IPOINT
T_MESSAGE
T_COLOR32
T_FILE
T_MEM_OBJ
T_RECT
T_POINT
T_VARIANT
T_RAW
T_SHORTCUTKEY
T_FONT
T_DATETIME
T_USER

---

Function Documentation

void os::__set_default_color	(	default_color_t	nColor,
		const Color32_s &	sColor
	)

int os::BitsPerPixel

(

color_space

eColorSpc

)

[inline]

uint16 os::COL_TO_RGB15

(

const Color32_s &

col

)

[inline]

uint16 os::COL_TO_RGB16

(

const Color32_s &

col

)

[inline]

uint32 os::COL_TO_RGB32

(

const Color32_s &

col

)

[inline]

void os::copy_files	(	const std::vector< os::String > &	cDstPaths,
		const std::vector< os::String > &	cSrcPaths,
		const Messenger &	cMsgTarget,
		Message *	pcFinishMsg,
		bool	bReplace = false,
		bool	bDontOverwrite = false
	)

void os::delete_files	(	const std::vector< os::String > &	cPaths,
		const Messenger &	cMsgTarget,
		Message *	pcFinishMsg
	)

Color32_s os::get_default_color

(

default_color_t

nColor

)

Description:

Call this function to obtain one of the user-configurable system colors. This should be used whenever possible instead of hardcoding colors to make it possible for the user to customize the look.

Note:

Warning:

Parameters:

nColor

- One of the COL_xxx enums from default_color_t

Returns:

The current color for the given system pen.

See also:

Author:

Kurt Skauen ([email protected])

Bitmap * os::get_std_bitmap	(	int	nBitmap,
		int	nColor,
		Rect *	pcRect
	)

Color32_s os::GetStdColor

(

int

i

)

bool os::is_first_utf8_byte

(

uint8

nByte

)

[inline]

void os::move_files	(	const std::vector< os::String > &	cDstPaths,
		const std::vector< os::String > &	cSrcPaths,
		const Messenger &	cMsgTarget,
		Message *	pcFinishMsg,
		bool	bReplace = false,
		bool	bDontOverwrite = false
	)

Color32_s os::RGB15_TO_COL

(

uint16

pix

)

[inline]

Color32_s os::RGB16_TO_COL

(

uint16

pix

)

[inline]

Color32_s os::RGB32_TO_COL

(

uint32

pix

)

[inline]

Color32_s os::RGBA15_TO_COL

(

uint16

pix

)

[inline]

void os::set_default_color	(	default_color_t	nColor,
		const Color32_s &	sColor
	)

int os::unicode_to_utf8	(	char *	pzDst,
		uint32	nChar
	)			[inline]

int os::utf8_char_length

(

uint8

nFirstByte

)

[inline]

int os::utf8_to_unicode

(

const char *

pzSource

)

[inline]

---

Variable Documentation

const uint8 os::__5_to_8_bit_table

const uint8 os::__6_to_8_bit_table

---