constants.h

The major functionality added in this release includes: - Rootless mode in X11 - Widget Templt

#define PGTH_O_BUTTON_ON             5    //!< Button, mouse is pressed 
#define PGTH_O_TOOLBAR               6    //!< The toolbar widget 
#define PGTH_O_SCROLL                7    //!< The scrollbar widget 
#define PGTH_O_SCROLL_HILIGHT        8    //!< Scroll, when mouse is over it 
#define PGTH_O_INDICATOR             9    //!< The indicator widget 
#define PGTH_O_PANEL                 10   //!< The background portion of a panel 
#define PGTH_O_PANELBAR              11   //!< The draggable titlebar of a panel 
#define PGTH_O_POPUP                 12   //!< Popup window 
#define PGTH_O_BACKGROUND            13   //!< Background widget bitmap 
#define PGTH_O_BASE_DISPLAY          14   //!< Base for widgets that mostly display stuff 
#define PGTH_O_BASE_TLCONTAINER      15   //!< Top-level containers like popups, panels  
#define PGTH_O_THEMEINFO             16   //!< Information about the theme that should be loaded into memory, like the name 
#define PGTH_O_LABEL                 17   //!< The label widget 
#define PGTH_O_FIELD                 18   //!< The field widget 
#define PGTH_O_BITMAP                19   //!< The bitmap widget 
#define PGTH_O_SCROLL_ON             20   //!< Scroll, when mouse is down 
#define PGTH_O_LABEL_SCROLL          21   //!< A label, when bound to a scrollbar 
#define PGTH_O_PANELBAR_HILIGHT      22   //!< A panelbar, when mouse is inside it 
#define PGTH_O_PANELBAR_ON           23   //!< A panelbar, when mouse is down 
#define PGTH_O_BOX                   24   //!< The box widget 
#define PGTH_O_LABEL_DLGTITLE        25   //!< A label, used for a dialog box title 
#define PGTH_O_LABEL_DLGTEXT         26   //!< A label, used for the body of a dialog 
#define PGTH_O_CLOSEBTN              27   //!< A panelbar close button 
#define PGTH_O_CLOSEBTN_ON           28   //!< A panelbar close button, mouse down 
#define PGTH_O_CLOSEBTN_HILIGHT      29   //!< A panelbar close button, mouse over 
#define PGTH_O_BASE_PANELBTN         30   //!< Base for a panelbar button 
#define PGTH_O_ROTATEBTN             31   //!< A panelbar rotate button 
#define PGTH_O_ROTATEBTN_ON          32   //!< A panelbar rotate button, mouse down 
#define PGTH_O_ROTATEBTN_HILIGHT     33   //!< A panelbar rotate button, mouse over 
#define PGTH_O_ZOOMBTN               34   //!< A panelbar zoom button 
#define PGTH_O_ZOOMBTN_ON            35   //!< A panelbar zoom button, mouse down 
#define PGTH_O_ZOOMBTN_HILIGHT       36   //!< A panelbar zoom button, mouse over 
#define PGTH_O_POPUP_MENU            37   //!< A popup menu 
#define PGTH_O_POPUP_MESSAGEDLG      38   //!< A message dialog 
#define PGTH_O_MENUITEM              39   //!< Item in a popup menu (customized button) 
#define PGTH_O_MENUITEM_HILIGHT      40   //!< menuitem with the mouse over it 
#define PGTH_O_CHECKBOX              41   //!< Check box (customized button) 
#define PGTH_O_CHECKBOX_HILIGHT      42   //!< checkbox with mouse over it 
#define PGTH_O_CHECKBOX_ON           43   //!< checkbox when on 
#define PGTH_O_FLATBUTTON            44   //!< Flat button (customized button) 
#define PGTH_O_FLATBUTTON_HILIGHT    45   //!< flatbutton with mouse over it 
#define PGTH_O_FLATBUTTON_ON         46   //!< flatbutton with mouse down 
#define PGTH_O_LISTITEM              47   //!< Listitem (customized button)
#define PGTH_O_LISTITEM_HILIGHT      48   //!< Listitem with mouse over it
#define PGTH_O_LISTITEM_ON           49   //!< Selected listitem
#define PGTH_O_CHECKBOX_ON_NOHILIGHT 50   //!< checkbox when on but not hilighted
#define PGTH_O_SUBMENUITEM           51   //!< Submenuitem
#define PGTH_O_SUBMENUITEM_HILIGHT   52   //!< Hilighted submenuitem
#define PGTH_O_RADIOBUTTON           53   //!< Radio button (cust. button)
#define PGTH_O_RADIOBUTTON_HILIGHT   54   //!< Radio button (cust. button)
#define PGTH_O_RADIOBUTTON_ON        55   //!< Radio button (cust. button)
#define PGTH_O_RADIOBUTTON_ON_NOHILIGHT 56 //!< Radio button (cust. button)
#define PGTH_O_TEXTBOX               57   //!< Textbox widget
#define PGTH_O_TERMINAL              58   //!< Terminal widget
#define PGTH_O_MENUBUTTON            60   //!< DSPLinux Application Menu
#define PGTH_O_MENUBUTTON_ON         61   //!< DSPLinux Application Menu
#define PGTH_O_MENUBUTTON_HILIGHT    62   //!< DSPLinux Application Menu
#define PGTH_O_LABEL_HILIGHT         63   //!< Label hilight or select - See PG_WP_HILIGHTED
#define PGTH_O_BOX_HILIGHT           64   //!< Box hilight or select - See PG_WP_HILIGHTED
#define PGTH_O_INDICATOR_H           65   //!< Horizontal indicator
#define PGTH_O_INDICATOR_V           66   //!< Vertical indicator
#define PGTH_O_SCROLL_H              67   //!< Horizontal scrollbar
#define PGTH_O_SCROLL_V              68   //!< Vertical scrollbar
#define PGTH_O_SCROLL_H_ON           69   //!< Clicked horizontal scrollbar
#define PGTH_O_SCROLL_H_HILIGHT      70   //!< Hilighted horizontal scrollbar
#define PGTH_O_SCROLL_V_ON           71   //!< Clicked vertical scrollbar
#define PGTH_O_SCROLL_V_HILIGHT      72   //!< Hilighted vertical scrollbar
#define PGTH_O_PANELBAR_H            73   //!< Horizontal panelbar
#define PGTH_O_PANELBAR_V            74   //!< Vertical panelbar
#define PGTH_O_PANELBAR_H_ON         75   //!< Clicked horizontal panelbar
#define PGTH_O_PANELBAR_H_HILIGHT    76   //!< Hilighted horizontal panelbar
#define PGTH_O_PANELBAR_V_ON         77   //!< Clicked vertical panelbar
#define PGTH_O_PANELBAR_V_HILIGHT    78   //!< Hilighted vertical panelbar
#define PGTH_O_TEXTEDIT              79   //!< textedit widget
#define PGTH_O_MANAGEDWINDOW         80   //!< Window managed by a host GUI
#define PGTH_O_TAB_PAGE              81   //!< The body of a tab page
#define PGTH_O_TAB_BAR               82   //!< The bar containing tabs
#define PGTH_O_TAB                   83   //!< An inactive tab
#define PGTH_O_TAB_HILIGHT           84   //!< A tab with the mouse over it
#define PGTH_O_TAB_ON                85   //!< An active tab
#define PGTH_O_TAB_ON_NOHILIGHT      86   //!< An active tab without the mouse over it

//! If you add a themeobject, be sure to increment this and add an inheritance entry in theme/memtheme.c
#define PGTH_ONUM                    87

//! Using a theme object named "custom" makes the server automatically allocate a free theme object at load time
#define PGTH_O_CUSTOM                0x7FFF

//! \}

/*** Loaders */

/*!
 * \defgroup thloadconst Theme loaders
 *
 * Theme loaders perform some type of transformation on a property's
 * value as it is loaded.
 *
 * \{
 */

#define PGTH_LOAD_NONE       0   //!< Leave data as-is
/*! 
 * \brief Load a request packet
 *
 * Treat data as a file-offset to load a request packet
 * from. This request packet is executed, and the
 * return code stored as the new property value.
 * Errors in processing the request cause an error
 * in loading the theme.
 */
#define PGTH_LOAD_REQUEST    1
/*!
 * \brief Copy an existing property value
 * 
 * The property data is treated as a theme object and property
 * pair. A theme lookup is performed, and the result stored
 * as the property's value.
 */
#define PGTH_LOAD_COPY       2   
/*!
 * \brief Find a theme object by name
 *
 * The property data is a file-offset to a zero-terminated
 * string representing the name of a theme object.
 * The theme object's ID is used as the property's new value.
 * This could be accomplished using PGTH_LOAD_REQUEST and 
 * PGREQ_FINDTHOBJ, but that wouldn't work for loding from
 * the current theme.
 */
#define PGTH_LOAD_FINDTHOBJ  3

//! \}

/*** Property IDs */

/*!
 * \defgroup themeprop Theme properties
 *
 * The descriptions here are only guidelines. Many of these properties
 * are not used by the server itself, merely assigned IDs for the
 * use of the themes themselves (from within fillstyles, for example)
 * 
 * \{
 */

#define PGTH_P_BGCOLOR       1   //!< Default background color 
#define PGTH_P_FGCOLOR       2   //!< Default foreground color 
#define PGTH_P_BGFILL        3   //!< Background fillstyle    
#define PGTH_P_OVERLAY       4   //!< Fillstyle for scroll thumbs, the filled portion of an indicator  
#define PGTH_P_FONT          5   //!< A widget's main font     
#define PGTH_P_NAME          6   //!< Name of the theme object, themes can be searched by this
#define PGTH_P_WIDTH         7   //!< Reccomended width 
#define PGTH_P_HEIGHT        8   //!< Reccomended height 
#define PGTH_P_MARGIN        9   //!< The border in some objects 
#define PGTH_P_HILIGHTCOLOR  10  //!< Color for hilighting an object 
#define PGTH_P_SHADOWCOLOR   11  //!< Color for shading an object 
#define PGTH_P_OFFSET        12  //!< An amount to displace something by 
#define PGTH_P_ALIGN         13  //!< How to position an object's contents
#define PGTH_P_BITMAPSIDE    14  //!< Bitmap side relative to text (button) 
#define PGTH_P_BITMAPMARGIN  15  //!< Spacing between bitmap and text 
#define PGTH_P_BITMAP1       16  //!< Generic bitmap property for theme use 
#define PGTH_P_BITMAP2       17  //!< Generic bitmap property for theme use 
#define PGTH_P_BITMAP3       18  //!< Generic bitmap property for theme use 
#define PGTH_P_BITMAP4       19  //!< Generic bitmap property for theme use 
#define PGTH_P_SPACING       20  //!< Distance between similar widgets 
#define PGTH_P_TEXT          21  //!< Text caption for something like a button 
#define PGTH_P_SIDE          22  //!< Side for a widget or subwidget 
#define PGTH_P_BACKDROP      23  //!< Fillstyle on the screen behind a popup 
#define PGTH_P_WIDGETBITMAP  24  //!< Bitmap for something like a button 
#define PGTH_P_WIDGETBITMASK 25  //!< Bitmask for something like a button 
#define PGTH_P_CURSORBITMAP  26  //!< Bitmap for the (mouse) pointer 
#define PGTH_P_CURSORBITMASK 27  //!< Bitmask for the (mouse) pointer 
#define PGTH_P_HIDEHOTKEYS   28  //!< Set to a PG_HHK_* constant
#define PGTH_P_ATTR_DEFAULT  29  //!< Default attribute for the terminal
#define PGTH_P_ATTR_CURSOR   30  //!< Default attribute for the terminal
#define PGTH_P_TEXTCOLORS    31  //!< Text color pallete for the terminal
#define PGTH_P_TIME_ON       32  //!< Milliseconds on for flashing cursor
#define PGTH_P_TIME_OFF      33  //!< Milliseconds off for flashing cursor
#define PGTH_P_TIME_DELAY    34  //!< Milliseconds to wait before flashing
#define PGTH_P_PARENT        35  //!< Overrides the default theme inheritance
#define PGTH_P_XOFFSET       36  //!< General purpose
#define PGTH_P_YOFFSET       37  //!< General purpose
#define PGTH_P_TICKS         38  //!< The time in millisecond ticks (use with caution)
#define PGTH_P_CRSRHOTSPOT_X 39  //!< Hotspot X position on the mouse cursor
#define PGTH_P_CRSRHOTSPOT_Y 40  //!< Hotspot Y position on the mouse cursor
#define PGTH_P_CURSOR_WIDTH  41  //!< Width of the text editing cursor 
#define PGTH_P_BORDER_SIZE   42  //!< Width of outer border on a panel widget
#define PGTH_P_BORDER_FILL   43  //!< Fillstyle for the outer border
#define PGTH_P_OBJECT_ON     60  /* Subobjects for the button widget */
#define PGTH_P_OBJECT_ON_NOHILIGHT 61
#define PGTH_P_OBJECT_HILIGHT 62

/* These should be removed when the standard dialogs are redone,
 * in favor of sticking to custom theme objects!
 */
#define PGTH_P_ICON_OK            1000   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_OK_MASK       1001   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_CANCEL        1002   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_CANCEL_MASK   1003   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_YES           1004   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_YES_MASK      1005   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_NO            1006   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_NO_MASK       1007   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_ERROR         1008   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_ERROR_MASK    1009   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_MESSAGE       1010   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_MESSAGE_MASK  1011   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_QUESTION      1012   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_QUESTION_MASK 1013   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_WARNING       1014   //!< Icon property (usually in PGTH_O_DEFAULT)
#define PGTH_P_ICON_WARNING_MASK  1015   //!< Icon property (usually in PGTH_O_DEFAULT)

#define PGTH_P_HOTKEY_OK          1501   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_CANCEL      1502   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_YES         1503   //!< Hotkey property (usually in PGTH_O_DEFAULT)   
#define PGTH_P_HOTKEY_NO          1504   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_UP          1505   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_DOWN        1506   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_LEFT        1507   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_RIGHT       1508   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_ACTIVATE    1509   //!< Hotkey property (usually in PGTH_O_DEFAULT) 
#define PGTH_P_HOTKEY_NEXT        1510   //!< Hotkey property (usually in PGTH_O_DEFAULT) 

//! Application-defined theme properties start here
#define PGTH_P_USER               10000

//! Automatically allocated properties used only by the theme start here
#define PGTH_P_THEMEAUTO          20000

#define PG_HHK_NONE          0           //!< Do not hide any buttons
#define PG_HHK_RETURN_ESCAPE 1           //!< Hide buttons hotkeyed to return or escape

//! \}

/*** Tag IDs */

/*!
 * \defgroup thtagconst Theme tag constants
 * 
 * Theme tags are designed to store extra data about a theme that
 * does not need to be loaded into memory for the theme to
 * function. 
 *
 * The name of the theme is not stored in a tag, because it is helpful
 * to have the name of themes stored in memory so they can be referenced
 * more easily.
 *
 * \{ 
 */

#define PGTH_TAG_AUTHOR        1
#define PGTH_TAG_AUTHOREMAIL   2
#define PGTH_TAG_URL           3
#define PGTH_TAG_README        4

//! \}

/*** Fillstyle opcodes */

/*!
 * \defgroup fsops Fillstyle opcodes
 *
 * A fillstyle is a small stack-based program in a
 * theme that can perform theme lookups and create gropnodes,
 * among other things. The fillstyle code is compiled by \p themec
 * into a series of opcodes, described in this section.
 * 
 * When the fillstyle interpreter is expecting a new opcode,
 * there are five types of bytes it could find:
 * 
 * \verbatim
  
   Bits:  7 6 5 4 3 2 1 0
          
	  1 G G G G G G G    Build gropnode
          0 1 L L L L L L    Short numeric literal
	  0 0 1 C C C C C    Command code
          0 0 0 1 V V V V    Retrieve variable
	  0 0 0 0 V V V V    Set variable 

   L - numeric literal
   G - gropnode type
   V - variable offset
   C - command code constant

\endverbatim
 * 
 * These five types (corresponding to the PGTH_OPSIMPLE_* constants)
 * implement frequently-used commands in one byte. Longer opcodes
 * use PGTH_OPSIMPLE_CMDCODE to store a PGTH_OPCMD_* constant with the
 * actual opcode.
 * 
 * \{
 */

#define PGTH_OPSIMPLE_GROP       0x80   //!< Create a gropnode, 7-bit gropnode type
#define PGTH_OPSIMPLE_LITERAL    0x40   //!< Push a 6-bit numeric literal onto the stack
#define PGTH_OPSIMPLE_CMDCODE    0x20   //!< Container for a PG_OPCMD_* opcode
#define PGTH_OPSIMPLE_GET        0x10   //!< Push a copy of a variable at the indicated 4-bit stack offset
#define PGTH_OPSIMPLE_SET        0x00   //!< Pop a value off the stack and overwrite the indicated variable

/* Command codes */
#define PGTH_OPCMD_LONGLITERAL   0x20   //!< Followed by a 4-byte literal
#define PGTH_OPCMD_PLUS          0x21 
#define PGTH_OPCMD_MINUS         0x22
#define PGTH_OPCMD_MULTIPLY      0x23
#define PGTH_OPCMD_DIVIDE        0x24
#define PGTH_OPCMD_SHIFTL        0x25
#define PGTH_OPCMD_SHIFTR        0x26
#define PGTH_OPCMD_OR            0x27
#define PGTH_OPCMD_AND           0x28