Difference between revisions of "DataGrid DesignObj"

Latest revision as of 14:28, 12 June 2011

The DataGrid DesignObj has a variety of options that can be used in HADesigner. Most of them are self explanatory, however, some of them, I am needing to dig through Orbiter.cpp to gather the meaning:

DesignObj Parameters

Shown below are the designObj parameters.. Hopefully most of these make sense, and are kept here for reference.

Number of Columns

The number of columns that will be shown inside the container. This is independent of the size of the data grid container itself on the parent designobj.

Number of Rows

The number of rows that will be shown inside the container. This is independent of the size of the data grid container itself on the parent designobj.

Fixed Row Height

This is the size in pixels of the size of each row. 150 is a good size.

Fixed Column Width

This is the size in pixels of the size of each column.

Row Spacing

The number of pixels between each row.

Column Spacing

The Number of pixels between each column.

First Row Height

The Height in pixels of the first row.

First Column Width

The Width in pixels of the first column.

Keep Row Header

Boolean value (0 for false, 1 for true), specifying that the first row should remain visible between page scrolls (makes most sense with RP)

Keep Column Header

Boolean value (0 for false, 1 for true), specifying that the first column should remain visible between page scrolls.

Initial Column Number

The Initial column number, starting from 0, to display on load.

Initial Row Number

The Initial row number, starting from 0 to display on load.

Is Multi Select

Boolean value (0 for false, 1 for true), specifying that multiple cells in the data grid can be selected.

PK_Variable

Use this variable # to store the activated cell, or cell selections (if multi select is 1). Look at the Orbiter Variables table.

Data Grid ID

not sure how this is used exactly. PLEASE FILL ME IN (FILLMEIN)

Cycle Grid

...dunno, look more into this. (FILLMEIN)

Options

Usually some really funky stuff in here.. look at how this is parsed in Orbiter.cpp! (FILLMEIN)

Extra Info

Takes a set of letters in any order that specify the way the DataGrid is rendered.

What i've currently found:

• R = When a row is selected, highlight the entire row.
• C = When a Column is selected, highlight the entire column
• P = Add Page Up/Page Down data grid entries (i.e. RP is used in the playlists on the standard orbiters)
• S = Add Spinning Cube scrolling functionality for UI2 (RS is used on playlists on UI2 On Screen Orbiters)

The following is a direct copy from the Orbiter.cpp code.

• 'H' means select a cell when a user highlights it
• 'R' or 'C' means only highlight/select whole rows/columns
• Either 'A' means arrows scroll the grid. If 'H' is not specified, the scrolling will be selecting cells. Otherwise it will be highlighting them
• 'As' means arrows scroll the grid 1 cell at a time
• 'Ap' means arrows scroll the grid 1 page at a time
• 'P' means make the first/last cell a 'page up'/'page down'
• 'h' means that moving the highlight should de-select any selected cells so you don't have both a highlighted and selected cell. Only meaningfull with 'H'.
• 'X' means that clear the selected cell entry whenever the user scrolls
• 'S' means that on the initial acquire it should scroll to the highlighted cell
• 'cx' means if this is a phone on Bluetooth dongle, render this grid as a single column on the phone using the column x
• 'T' - (for PlutoMO only) PlutoMO will send SelectedItem everytime the position on the grid is changed.
• 'F' - force rendering in Orbiter

PK_Datagrid

References the data grid # in the DataGrid table. This is paired up with the DataGrid generator hook that is used to link a data source to the right data grid in designer.

PK_Style

The Style of each cell (see Style table)

PK_Style_FirstRow

The Style of the first row

... to be continued ...