The Syllable Graphical User Interface API


Classes

class  os::Bitmap
 Container for bitmap-image data. More...
class  os::Button
 Simple push-button class. More...
class  os::CheckBox
 2-state check box. More...
class  os::CheckMenu
 
Description:
A menuitem which can either be "On" or "Off"
More...
class  os::ColorRequester
 Color Requester. More...
class  os::ColorSelector
 ColorSelector. More...
class  os::Control
 Base class for GUI controls. More...
class  os::FileRow
 Directory browser control. More...
class  os::DirectoryView
 Directory view suitable for file-requesters and other file browsers. More...
class  os::DropdownMenu
 Edit box with an asociated item-menu. More...
class  os::FileRequester
 Generic file requester. More...
class  os::Font
 Text Font class. More...
class  os::FontRequester
 Font Requester. More...
class  os::FrameView
 
Description:
A view with a border surrounding it, and an optional title.
More...
struct  os::Color32_s
 Colour datatype. More...
class  os::IconDirectoryView
 Directory view suitable for file-requesters and other file browsers. More...
class  os::IconView
 Icon view with different views. More...
class  os::Image
 Container for image data. More...
class  os::BitmapImage
 Container for bitmap image data. More...
class  os::ImageButton
 Imagebutton gui element. More...
class  os::ImageView
 View class for Image objects. More...
class  os::InputBox
 Simple InputBox class. More...
class  os::LayoutNode
 Layout node. More...
class  os::LayoutSpacer
 Layout spacer. More...
class  os::VLayoutSpacer
 Vertical layout spacer. More...
class  os::HLayoutSpacer
 Horizontal layout spacer. More...
class  os::HLayoutNode
 Horizontal Layout class. More...
class  os::VLayoutNode
 Vertical Layout class. More...
class  os::LayoutView
 Main class in the Syllable dynamic layout system. More...
class  os::ListViewRow
 
Description:
More...
class  os::ListViewStringRow
 
Description:
More...
class  os::ListView
 Flexible multicolumn list view. More...
class  os::MenuItem
 Menu item class. More...
class  os::MenuSeparator
 Menu separator item. More...
class  os::Menu
 The menuing system for Syllable. More...
class  os::Point
 
Description:
More...
class  os::IPoint
 
Description:
More...
class  os::PopupMenu
 Popupmenu gui element. More...
class  os::RadioButton
 
Description:
More...
class  os::Rect
 
Description:
More...
class  os::IRect
 
Description:
More...
struct  os::ClipRect
 
Description:
More...
class  os::Region
 
Description:
More...
class  os::Alert
 
Description:
More...
class  os::ScrollBar
 
Description:
The os::ScrollBar is one object that is used in a lot of other GUI elements.
More...
class  os::Separator
 Separator bar. More...
class  os::Slider
 
Description:
More...
class  os::Spinner
 
Description:
More...
class  os::Splitter
 Splitter View. More...
class  os::StatusPanel
 Base class for StatusBar panels. More...
class  os::StatusBar
 Status bar. More...
class  os::StringView
 
Description:
Display a non-editable text string (text label)-
More...
class  os::TabView
 
Description:
More...
class  os::TextView
 
Description:
More...
class  os::ToolBar
 ToolBar. More...
class  os::TreeViewNode
 Baseclass for TreeView nodes. More...
class  os::TreeViewStringNode
 TreeView node containing strings. More...
class  os::TreeView
 Flexible multicolumn tree view. More...
class  os::View
 Base class for all GUI components. More...
class  os::Window
 
Description:
More...

Enumerations

enum  os::tab_order {
  os::NO_TAB_ORDER = -1,
  os::NEXT_TAB_ORDER = -2
}
 Tab order allocation. More...
enum  os::view_flags {
  os::WID_FULL_UPDATE_ON_H_RESIZE = 0x0001,
  os::WID_FULL_UPDATE_ON_V_RESIZE = 0x0002,
  os::WID_FULL_UPDATE_ON_RESIZE = 0x0003,
  os::WID_WILL_DRAW = 0x0004,
  os::WID_TRANSPARENT = 0x0008,
  os::WID_CLEAR_BACKGROUND = 0x0010,
  os::WID_DRAW_ON_CHILDREN = 0x0020
}
 Flags controlling a View. More...
enum  os::view_resize_flags {
  os::CF_FOLLOW_NONE = 0x0000,
  os::CF_FOLLOW_LEFT = 0x0001,
  os::CF_FOLLOW_RIGHT = 0x0002,
  os::CF_FOLLOW_TOP = 0x0004,
  os::CF_FOLLOW_BOTTOM = 0x0008,
  os::CF_FOLLOW_ALL = 0x000F,
  os::CF_FOLLOW_H_MIDDLE = 0x0010,
  os::CF_FOLLOW_V_MIDDLE = 0x0020,
  os::CF_FOLLOW_SPECIAL = 0x0040,
  os::CF_FOLLOW_MASK = 0x007f
}
 Flags controlling how to resize/move a view when the parent is resized. More...

Detailed Description

Here you will find documentation of the various C++ classes involved in the Syllable GUI API.

Unlike your favourite UNIX/X11 OS, Syllable has an "integrated" high level GUI with a flexible highlevel object oriented API. The GUI is implemented as a server/client system, much like X11, but the protocol is private to the server (the application server) and the client (The highlevel GUI API library) and is never revealed to the applications. Applcations only relates to the classes in the GUI toolkit.

NOTE: This documentation is not complete. Our goal is to document new classes as they are written, and to add documentation to existing classes where it is missing. Many of our classes were inherited from Kurt Skauen's AtheOS project, and some of these lack proper documentation. Until full documentation exists, it is a good idea to take a look at the various header files to see what is available and the various "example" sources (the application sources available for download) to learn how to use it.


Enumeration Type Documentation

enum os::tab_order

See also:
os::View::SetTabOrder
Enumerator:
NO_TAB_ORDER 
NEXT_TAB_ORDER 

enum os::view_flags

See also:
os::view_resize_flags, os::View
Author:
Kurt Skauen ([email protected])
Enumerator:
WID_FULL_UPDATE_ON_H_RESIZE  Cause the entire view to be invalidated if made higher.
WID_FULL_UPDATE_ON_V_RESIZE  Cause the entire view to be invalidated if made wider.
WID_FULL_UPDATE_ON_RESIZE  Cause the entire view to be invalidated if resized.
WID_WILL_DRAW  Tell the appserver that you want to render stuff to it.
WID_TRANSPARENT  Allow the parent view to render in areas covered by this view.
WID_CLEAR_BACKGROUND  Automatically clear new areas when windows are moved/resized.
WID_DRAW_ON_CHILDREN  Setting this flag allows the view to render atop of all its childs.

enum os::view_resize_flags

See also:
os::view_flags, os::View
Author:
Kurt Skauen ([email protected])
Enumerator:
CF_FOLLOW_NONE  Neither the size nor the position is changed.
CF_FOLLOW_LEFT  Left edge follows the parents left edge.
CF_FOLLOW_RIGHT  Right edge follows the parents right edge.
CF_FOLLOW_TOP  Top edge follows the parents top edge.
CF_FOLLOW_BOTTOM  Bottom edge follows the parents bottom edge.
CF_FOLLOW_ALL  All edges follows the corresponding edge in the parent.
CF_FOLLOW_H_MIDDLE  If the CF_FOLLOW_LEFT is set the right edge follows the parents center.

if the CF_FOLLOW_RIGHT is set the left edge follows the parents center.

CF_FOLLOW_V_MIDDLE  If the CF_FOLLOW_TOP is set the bottom edge follows the parents center.

if the CF_FOLLOW_BOTTOM is set the top edge follows the parents center.

CF_FOLLOW_SPECIAL 
CF_FOLLOW_MASK 


Generated on Sat May 9 22:50:57 2009 for Syllable higlevel API by  doxygen 1.5.1