Class StringGridWidgetBase
Constructors
| Name | Description |
|---|---|
this
(ID)
|
Fields
| Name | Type | Description |
|---|---|---|
_backgroundDrawable
|
Ref!(dcanvas.graphics.resources.Drawable) | |
cellActivated
|
Listener!(dcanvas.widgets.grid.CellActivatedHandler) | Callback to handle cell double click |
cellPopupMenu
|
Signal!(dcanvas.widgets.grid.CellPopupMenuHandler) | cell popup menu |
cellSelected
|
Listener!(dcanvas.widgets.grid.CellSelectedHandler) | Callback to handle selection change |
checkChange
|
Signal!(dcanvas.widgets.widget.OnCheckHandler) | checked state change event listener (bool delegate(Widget, bool)) |
click
|
Signal!(dcanvas.widgets.widget.OnClickHandler) | on click event listener (bool delegate(Widget)) |
doubleClick
|
Signal!(dcanvas.widgets.widget.OnDoubleClickHandler) | On double click event listener (bool delegate(Widget)) |
focusChange
|
Signal!(dcanvas.widgets.widget.OnFocusHandler) | focus state change event listener (bool delegate(Widget, bool)) |
headerCellClicked
|
Listener!(dcanvas.widgets.grid.HeaderCellClickHandler) | Callback for handling header cell click |
keyEvent
|
Signal!(dcanvas.widgets.widget.OnKeyHandler) | key event listener (bool delegate(Widget, KeyEvent)) - return true if event is processed by handler |
keyToAction
|
Listener!(dcanvas.widgets.widget.OnKeyActionHandler) | action by key lookup handler |
menuItemAction
|
Signal!(dcanvas.widgets.menu.MenuItemActionHandler) | popup menu item action |
mouseEvent
|
Signal!(dcanvas.widgets.widget.OnMouseHandler) | mouse event listener (bool delegate(Widget, MouseEvent)) - return true if event is processed by handler |
onAction
|
Signal!(dcanvas.widgets.widget.OnActionHandler) | action handlers |
viewScrolled
|
Listener!(dcanvas.widgets.grid.ViewScrolledHandler) | Callback for handling of view scroll (top left visible cell change) |
_acceleratorMap
|
ActionMap | |
_action
|
Action | |
_allowColResizing
|
bool | |
_cellBorderColor
|
uint | |
_cellHeaderBackgroundColor
|
uint | |
_cellHeaderBackgroundDrawable
|
Ref!(dcanvas.graphics.resources.Drawable) | |
_cellHeaderBorderColor
|
uint | |
_cellHeaderSelectedBackgroundColor
|
uint | |
_cellHeaderSelectedBackgroundDrawable
|
Ref!(dcanvas.graphics.resources.Drawable) | |
_cellRowHeaderBackgroundDrawable
|
Ref!(dcanvas.graphics.resources.Drawable) | |
_cellRowHeaderSelectedBackgroundDrawable
|
Ref!(dcanvas.graphics.resources.Drawable) | |
_changedSize
|
bool | |
_checkable
|
bool | |
_checked
|
bool | |
_children
|
ObjectList!(dcanvas.widgets.widget.Widget) | |
_clickable
|
bool | |
_clientRect
|
Rect | inner area, excluding additional controls like scrollbars |
_col
|
int | selected cell column |
_colCumulativeWidths
|
int[] | total width from first column to right of this |
_colResizingIndex
|
int | |
_colResizingStartWidth
|
int | |
_colResizingStartX
|
int | |
_cols
|
int | column count (including header columns and fixed columns) |
_colWidths
|
int[] | column widths |
_customCellAdapter
|
CustomGridCellAdapter | |
_defColumnWidth
|
int | default column width - for newly added columns |
_defRowHeight
|
int | default row height - for newly added rows |
_fixedCellBackgroundColor
|
uint | |
_fixedCellBorderColor
|
uint | |
_fixedCols
|
int | number of fixed (non-scrollable) columns |
_fixedRows
|
int | number of fixed (non-scrollable) rows |
_focusable
|
bool | |
_focusGroup
|
bool | |
_fullColumnOnLeft
|
bool | |
_fullRowOnTop
|
bool | |
_fullScrollableArea
|
Rect | |
_gridModelAdapter
|
GridModelAdapter | |
_headerCols
|
int | number of header columns (e.g. like row number in excel; 0 for no header column) |
_headerRows
|
int | number of header rows (e.g. like col name A, B, C... in excel; 0 for no header row) |
_hscrollbar
|
ScrollBar | horizontal scrollbar control |
_hscrollbarMode
|
ScrollBarMode | |
_id
|
string | widget id |
_insideChangeScrollbarVisibility
|
bool | |
_maxScrollCol
|
int | |
_maxScrollRow
|
int | |
_measuredHeight
|
int | height measured by measure() |
_measuredWidth
|
int | width measured by measure() |
_minVisibleCols
|
int | |
_minVisibleRows
|
int | |
_multiSelect
|
bool | when true, allows multi cell selection |
_needDraw
|
bool | true to force redraw |
_needLayout
|
bool | true to force layout |
_ownStyle
|
Style | own copy of style - to override some of style properties, null of no properties overriden |
_parent
|
Widget | parent widget |
_popupMenu
|
MenuItem | |
_pos
|
Rect | current widget position, set by layout() |
_row
|
int | selected cell row |
_rowCumulativeHeights
|
int[] | total height from first row to bottom of this |
_rowHeights
|
int[] | row heights |
_rows
|
int | row count (including header rows and fixed rows) |
_rowSelect
|
bool | when true, allows to select only whole row |
_scrollX
|
int | scroll X offset in pixels |
_scrollY
|
int | scroll Y offset in pixels |
_selection
|
std | selected cells when multiselect is enabled |
_selectionColor
|
uint | |
_selectionColorRowSelect
|
uint | |
_showColHeaders
|
bool | when true, shows col headers row |
_showRowHeaders
|
bool | when true, shows row headers column |
_smoothHScroll
|
bool | |
_smoothVScroll
|
bool | |
_state
|
uint | widget state (set of flags from State enum) |
_styleId
|
string | style id to lookup style in theme |
_tabOrder
|
ushort | |
_tooltipText
|
UIString | |
_trackHover
|
bool | does widget need to track mouse Hover |
_visibility
|
Visibility | widget visibility: either Visible, Invisible, Gone |
_visibleScrollableArea
|
Rect | |
_vscrollbar
|
ScrollBar | vertical scrollbar control |
_vscrollbarMode
|
ScrollBarMode | |
_window
|
Window | window (to be used for top level widgets only!) |
Properties
| Name | Type | Description |
|---|---|---|
acceleratorMap[get]
|
ActionMap | |
action[get, set]
|
const(Action) | action to emit on click |
alignment[get]
|
ubyte | returns alignment (combined vertical and horizontal) |
alignment[set]
|
Widget | sets alignment (combined vertical and horizontal) |
allowColResizing[get]
|
bool | get col resizing flag; when true, allow resizing of column with mouse |
allowColResizing[set]
|
GridWidgetBase | set col resizing flag; when true, allow resizing of column with mouse |
alpha[get]
|
uint | widget drawing alpha value (0=opaque .. 255=transparent) |
alpha[set]
|
Widget | set widget drawing alpha value (0=opaque .. 255=transparent) |
animating[get]
|
bool | returns true is widget is being animated - need to call animate() and redraw |
backgroundColor[get]
|
uint | returns background color |
backgroundColor[set]
|
Widget | set background color for widget - override one from style |
backgroundColor[set]
|
Widget | set background color for widget - from string like "#5599CC" or "white" |
backgroundDrawable[get, set]
|
Ref!(dcanvas.graphics.resources.Drawable) | background drawable |
backgroundImageId[get, set]
|
string | background image id |
canCheck[get]
|
bool | |
canClick[get]
|
bool | |
canFocus[get]
|
bool | returns true if widget is focusable and visible and enabled |
checkable[get]
|
bool | when true, control supports Checked state |
checkable[set]
|
Widget | |
checked[set]
|
Widget | set checked state |
checked[get]
|
bool | get checked state |
childCount[get]
|
int | returns number of children of this widget |
clickable[get]
|
bool | when true, user can click this control, and get onClick listeners called |
clickable[set]
|
Widget | |
clientRect[get]
|
Rect | returns client area rectangle |
col[get]
|
int | selected column |
cols[get]
|
int | column count |
cols[set]
|
GridWidgetBase | set column count |
customCellAdapter[get]
|
CustomGridCellAdapter | Get adapter to override drawing of some particular cells |
customCellAdapter[set]
|
GridWidgetBase | Set adapter to override drawing of some particular cells |
defColumnWidth[get]
|
int | default column width - for newly added columns |
defColumnWidth[set]
|
GridWidgetBase | |
defRowHeight[get]
|
int | default row height - for newly added rows |
defRowHeight[set]
|
GridWidgetBase | |
enabled[get]
|
bool | return true if state has State.Enabled flag set |
enabled[set]
|
Widget | change enabled state |
fixedCols[set]
|
int | |
fixedCols[get]
|
int | fixed (non-scrollable) data column count |
fixedRows[set]
|
int | |
fixedRows[get]
|
int | fixed (non-scrollable) data row count |
focusable[set]
|
Widget | |
focusable[get]
|
bool | whether widget can be focused |
focused[get]
|
bool | |
focusGroup[get]
|
bool | When focus group is set for some parent widget, focus from one of containing widgets can be moved using keyboard only to one of other widgets containing in it and cannot bypass bounds of focusGroup. |
focusGroup[set]
|
Widget | set focus group flag for container widget |
focusGroupFocused[get]
|
bool | |
focusGroupFocused[set]
|
Widget | |
focusRectColors[get]
|
const(uint[]) | returns colors to draw focus rectangle (one for solid, two for vertical gradient) or null if no focus rect should be drawn for style |
font[get]
|
Ref!(dcanvas.graphics.fonts.Font) | returns font set for widget using style or set manually |
fontFace[set]
|
Widget | set font face for widget - override one from style |
fontFace[get]
|
string | returns font face |
fontFamily[set]
|
Widget | set font family for widget - override one from style |
fontFamily[get]
|
FontFamily | returns font family |
fontItalic[set]
|
Widget | set font style (italic/normal) for widget - override one from style |
fontItalic[get]
|
bool | returns font style (italic/normal) |
fontSize[set]
|
Widget | set font size for widget - override one from style |
fontSize[get]
|
int | returns font size in pixels |
fontWeight[set]
|
Widget | set font weight for widget - override one from style |
fontWeight[get]
|
ushort | returns font weight |
fullAreaPixels[get]
|
Point | return all (fixed + scrollable) cells size in pixels |
fullColumnOnLeft[get, set]
|
bool | Extends scroll area to show full column at left when scrolled to rightmost column |
fullRowOnTop[get, set]
|
bool | Extends scroll area to show full row at top when scrolled to end row |
gridModelAdapter[set]
|
GridWidgetBase | Set adapter to hold grid model data |
gridModelAdapter[get]
|
GridModelAdapter | Get adapter to hold grid model data |
halign[get]
|
Align | returns vertical alignment |
hasTooltip[get]
|
bool | returns true if widget has tooltip to show |
headerCols[set]
|
GridWidgetBase | |
headerCols[get]
|
int | row header column count |
headerRows[set]
|
GridWidgetBase | |
headerRows[get]
|
int | col header row count |
height[get]
|
int | returns current height of widget in pixels |
hscrollbar[get]
|
ScrollBar | |
hscrollbar[set]
|
ScrollBar | |
hscrollbarMode[get]
|
ScrollBarMode | horizontal scrollbar mode |
hscrollbarMode[set]
|
ScrollBarMode | |
id[set]
|
Widget | set widget id |
id[get]
|
string | returns widget id, null if not set |
layoutHeight[set]
|
Widget | sets layout height options (WRAP_CONTENT, FILL_PARENT, or some constant value) |
layoutHeight[get]
|
int | returns layout height options (WRAP_CONTENT, FILL_PARENT, some constant value or percent but only for one widget in layout) |
layoutWeight[set]
|
Widget | sets layout weight (while resizing to fill parent, widget will be resized proportionally to this value) |
layoutWeight[get]
|
int | returns layout weight (while resizing to fill parent, widget will be resized proportionally to this value) |
layoutWidth[set]
|
Widget | sets layout width options (WRAP_CONTENT, FILL_PARENT, or some constant value) |
layoutWidth[get]
|
int | returns layout width options (WRAP_CONTENT, FILL_PARENT, some constant value or percent but only for one widget in layout) |
left[get]
|
int | returns widget rectangle left position |
margins[set]
|
Widget | set margins for widget with the same value for left, top, right, bottom - override one from style |
margins[set]
|
Widget | set margins for widget - override one from style |
margins[get]
|
Rect | get margins (between widget bounds and its background) |
maxHeight[set]
|
Widget | set max height constraint (SIZE_UNSPECIFIED for no constraint) |
maxHeight[get]
|
int | returns max height constraint (SIZE_UNSPECIFIED if no constraint set) |
maxWidth[set]
|
Widget | set max width constraint (SIZE_UNSPECIFIED for no constraint) |
maxWidth[get]
|
int | returns max width constraint (SIZE_UNSPECIFIED if no constraint set) |
measuredHeight[get]
|
int | returns measured height (calculated during measure() call) |
measuredWidth[get]
|
int | returns measured width (calculated during measure() call) |
minHeight[set]
|
Widget | set max height constraint (0 for no constraint) |
minHeight[get]
|
int | returns min height constraint |
minVisibleCols[get]
|
int | returns number of columns from 0 that are taken to measure minimum visible width |
minVisibleCols[set]
|
int | sets number of columns from 0 that are taken to measure minimum visible width |
minVisibleRows[get]
|
int | returns number of rows from 0 that are taken to measure minimum visible height |
minVisibleRows[set]
|
int | sets number of rows from 0 that are taken to measure minimum visible height, if there are too little rows last row height is multiplied |
minWidth[set]
|
Widget | set max width constraint (0 for no constraint) |
minWidth[get]
|
int | returns min width constraint |
multiSelect[set]
|
GridWidgetBase | |
multiSelect[get]
|
bool | when true, allows multi cell selection |
needDraw[get]
|
bool | returns true if redraw is required for widget and its children |
needLayout[get]
|
bool | returns true if layout is required for widget and its children |
nonScrollAreaPixels[get]
|
Point | non-scrollable area size in pixels |
nonScrollCols[get]
|
int | count of non-scrollable columns (header + fixed) |
nonScrollRows[get]
|
int | count of non-scrollable rows (header + fixed) |
ownStyle[get]
|
Style | enforces widget's own style - allows override some of style properties |
padding[set]
|
Widget | set padding for widget to the same value for left, top, right, bottom - override one from style |
padding[set]
|
Widget | set padding for widget - override one from style |
padding[get]
|
Rect | get padding (between background bounds and content of widget) |
parent[get]
|
Widget | returns parent widget, null for top level widget |
parent[set]
|
Widget | sets parent for widget |
popupMenu[get]
|
MenuItem | |
popupMenu[set]
|
Widget | |
pos[get]
|
Rect | returns widget rectangle |
resetState[set]
|
Widget | remove state flags (set of flags from State enum) |
row[get]
|
int | selected row |
rows[set]
|
GridWidgetBase | set row count |
rows[get]
|
int | row count |
rowSelect[get]
|
bool | when true, allows only select the whole row |
rowSelect[set]
|
GridWidgetBase | |
scrollAreaPixels[get]
|
Point | scrollable area size in pixels |
selection[get]
|
std | selected cells when multiselect is enabled |
setState[set]
|
Widget | add state flags (set of flags from State enum) |
showColHeaders[set]
|
GridWidgetBase | |
showColHeaders[get]
|
bool | flag to enable column headers |
showRowHeaders[set]
|
GridWidgetBase | |
showRowHeaders[get]
|
bool | flag to enable row headers |
smoothHScroll[get, set]
|
bool | Get smooth horizontal scroll flag - when true - scrolling by pixels, when false - by cells |
smoothVScroll[get, set]
|
bool | Get smooth vertical scroll flag - when true - scrolling by pixels, when false - by cells |
state[set]
|
Widget | set new widget state (set of flags from State enum) |
state[get]
|
uint | widget state (set of flags from State enum) |
styleId[get]
|
string | returns widget style id, null if not set |
styleId[set]
|
Widget | set widget style id |
tabOrder[get]
|
ushort | tab order - hint for focus movement using Tab/Shift+Tab |
tabOrder[set]
|
Widget | |
text[get]
|
dstring | returns widget content text (override to support this) |
text[set]
|
Widget | sets widget content text (override to support this) |
textColor[get]
|
uint | get text color (ARGB 32 bit value) |
textColor[set]
|
Widget | set text color (ARGB 32 bit value) |
textColor[set]
|
Widget | set text color for widget - from string like "#5599CC" or "white" |
textFlags[get]
|
uint | get text flags (bit set of TextFlag enum values) |
textFlags[set]
|
Widget | set text flags (bit set of TextFlag enum values) |
tooltipText[get, set]
|
dstring | tooltip text - when not empty, widget will show tooltips automatically; for advanced tooltips - override hasTooltip and createTooltip |
top[get]
|
int | returns widget rectangle top position |
trackHover[set]
|
Widget | set new trackHover flag value (when true, widget will change Hover state while mouse is moving) |
trackHover[get]
|
bool | mouse movement processing flag (when true, widget will change Hover state while mouse is moving) |
valign[get]
|
Align | returns horizontal alignment |
visibility[get]
|
Visibility | returns widget visibility (Visible, Invisible, Gone) |
visibility[set]
|
Widget | sets widget visibility (Visible, Invisible, Gone) |
visible[get]
|
bool | returns true if this widget and all its parents are visible |
vscrollbar[set]
|
ScrollBar | |
vscrollbar[get]
|
ScrollBar | |
vscrollbarMode[set]
|
ScrollBarMode | |
vscrollbarMode[get]
|
ScrollBarMode | vertical scrollbar mode |
wantsKeyTracking[get]
|
bool | override and return true to track key events even when not focused |
width[get]
|
int | returns current width of widget in pixels |
window[get]
|
Window | returns window (if widget or its parent is attached to window) |
window[set]
|
Window | sets window (to be used for top level widget from Window implementation). TODO: hide it from API? |
stateStyle[get]
|
const(Style) | returns style for current widget state |
style[get, set]
|
const(Style) | accessor to style - by lookup in theme by styleId (if style id is not set, theme base style will be used). |
Methods
| Name | Description |
|---|---|
cellText
(col, row)
|
get cell text |
colTitle
(col)
|
returns row header title |
rowTitle
(row)
|
returns row header title |
setCellText
(col, row, text)
|
set cell text |
setColTitle
(col, title)
|
set col header title |
setRowTitle
(row, title)
|
set row header title |
activateCell
(col, row)
|
Select cell and call onCellActivated handler |
addChild
(item)
|
adds child, returns added item |
addChildren
(items)
|
adds child, returns added item |
addOnCheckChangeListener
(listener)
|
helper function to add onCheckChangeListener in method chain |
addOnClickListener
(listener)
|
helper function to add onClickListener in method chain |
addOnFocusChangeListener
(listener)
|
helper function to add onFocusChangeListener in method chain |
animate
(interval)
|
animates window; interval is time left from previous draw, in hnsecs (1/10000000 of second) |
applyAlign
(rc, sz)
|
Applies alignment for content of size sz - set rectangle rc to aligned value of content inside of initial value of rc. |
applyMargins
(rc)
|
Helper function: applies margins to rectangle |
applyPadding
(rc)
|
Helper function: applies padding to rectangle |
autoFit
()
|
|
autoFitColumnWidth
(i)
|
|
autoFitColumnWidths
()
|
|
autoFitRowHeight
(i)
|
|
autoFitRowHeights
()
|
|
cancelLayout
()
|
|
cancelTimer
(timerId)
|
cancel timer - pass value returned from setTimer() as timerId parameter |
canShowPopupMenu
(x, y)
|
returns true if widget can show popup menu (e.g. by mouse right click at point x,y) |
cellRect
(x, y)
|
returns cell rectangle relative to client area; row 0 is col headers row; col 0 is row headers column |
cellRectNoScroll
(x, y)
|
get cell rectangle (relative to client area) not counting scroll position |
cellRectScroll
(x, y)
|
get cell rectangle moved by scroll pixels (may overlap non-scroll cols!) |
child
(index)
|
returns child by index |
childById
(id, deepSearch)
|
find child of specified type T by id, returns null if not found or cannot be converted to type T |
childIndex
(item)
|
returns index of widget in child list, -1 if passed widget is not a child of this widget |
colVisible
(x)
|
returns true if column is inside client area and not overlapped outside scroll area |
colWidth
(col)
|
get column width, 0 is header column |
compareId
(id)
|
compare widget id with specified value, returs true if matches |
createTooltip
(mouseX, mouseY, alignment, x, y)
|
will be called from window once tooltip request timer expired; if null is returned, popup will not be shown; you can change alignment and position of popup here |
dispatchAction
(a)
|
call to dispatch action |
drawFocusRect
(buf, rc)
|
draws focus rectangle, if enabled in styles |
executeInUiThread
(runnable)
|
execute delegate later in UI thread if this widget will be still available (can be used to modify UI from background thread, or just to postpone execution of action) |
fillColumnWidth
(colIndex)
|
extend specified column width to fit client area if grid width |
fillHorizontal
()
|
sets layoutWidth=FILL_PARENT |
fillParent
()
|
sets layoutWidth=FILL_PARENT and layoutHeight=FILL_PARENT |
fillVertical
()
|
sets layoutHeight=FILL_PARENT |
findFocusableChild
(defaultOnly)
|
searches children for first focusable item, returns null if not found |
findKeyAction
(keyCode, flags)
|
map key to action |
focusGroupWidget
()
|
find nearest parent of this widget with focusGroup flag, returns topmost parent if no focusGroup flag set to any of parents. |
fullContentSize
()
|
calculate full content size in pixels |
fullContentSizeWithBorders
()
|
calculate full content size in pixels including widget borders / margins |
getCursorType
(x, y)
|
returns mouse cursor type for widget |
handleActionStateChanged
()
|
called when state of action assigned on widget is changed |
handleActionStateRequest
(a)
|
override to handle specific actions state (e.g. change enabled state for supported actions) |
handleMoveFocusUsingKeys
(event)
|
|
insertChild
(item, index)
|
inserts child at given index, returns inserted item |
invalidate
()
|
request redraw |
isActionEnabled
(action)
|
override to change popup menu items state |
isChild
(item, deepSearch)
|
returns true if item is child of this widget (when deepSearch == true - returns true if item is this widget or one of children inside children tree). |
isColumnResizingPoint
(x, y)
|
return column index to resize if point is in column resize area in header row, -1 if outside resize area |
isPointInside
(pt)
|
|
isPointInside
(x, y)
|
returns true if point is inside of this widget |
layout
(rc)
|
Set widget rectangle to specified value and layout widget contents. (Step 2 of two phase layout). |
makeCellVisible
(col, row)
|
ensure that cell is visible (scroll if necessary) |
makeRectVisible
(rc, alignHorizontally, alignVertically)
|
|
measure
(parentWidth, parentHeight)
|
Measure widget according to desired width and height constraints. (Step 1 of two phase layout). |
minimumVisibleContentSize
()
|
calculate minimum size of widget |
multiSelectCell
(col, row, expandExisting)
|
|
onDraw
(buf)
|
Draw widget at its position to buffer |
onEvent
(event)
|
handle custom event |
onHScroll
(event)
|
process horizontal scrollbar event |
onKeyEvent
(event)
|
process key event, return true if event is processed. |
onMouseEvent
(event)
|
handle mouse wheel events |
onScrollEvent
(source, event)
|
handle scroll event |
onThemeChanged
()
|
handle theme change: e.g. reload some themed resources |
onTimer
(id)
|
handle timer; return true to repeat timer event after next interval, false cancel timer |
onVScroll
(event)
|
process vertical scrollbar event |
pointToCell
(x, y, col, row, cellRect)
|
converts client rect relative coordinates to cell coordinates |
removeAllChildren
(destroyObj)
|
|
removeChild
(child)
|
removes child, returns removed item |
removeChild
(ID)
|
removes child by ID, returns removed item |
removeChild
(index)
|
removes child, returns removed item |
replaceChild
(newChild, oldChild)
|
replace child with other child |
requestActionsUpdate
(immediateUpdate)
|
set action update request flag, will be cleared after redraw |
requestLayout
()
|
request relayout of widget and its children |
resize
(c, r)
|
set new size |
rowHeight
(row)
|
get row height, 0 is header row |
rowVisible
(y)
|
returns true if row is inside client area and not overlapped outside scroll area |
scheduleTooltip
(delay, alignment, x, y)
|
schedule tooltip |
scrollBy
(dx, dy)
|
move scroll position horizontally by dx, and vertically by dy; returns true if scrolled |
scrollTo
(x, y, source, doNotify)
|
set scroll position to show specified cell as top left in scrollable area; col or row -1 value means no change |
selectCell
(col, row, makeVisible, source, needNotification)
|
move selection to specified cell |
setBoolProperty
(name, value)
|
set string property value, for ML loaders |
setColWidth
(x, w)
|
|
setDoubleProperty
(name, value)
|
set double property value, for ML loaders |
setDstringProperty
(name, value)
|
set string property value, for ML loaders |
setFocus
(reason)
|
sets focus to this widget or suitable focusable child, returns previously focused widget |
setIntProperty
(name, value)
|
set int property value, for ML loaders |
setRectProperty
(name, value)
|
set Rect property value, for ML loaders |
setRowHeight
(y, w)
|
|
setStringListValueListProperty
(propName, values)
|
StringListValue list values |
setStringProperty
(name, value)
|
set string property value, for ML loaders |
setTimer
(intervalMillis)
|
set new timer to call onTimer() after specified interval (for recurred notifications, return true from onTimer) |
setUIStringListProperty
(propName, values)
|
UIString list values |
setUistringProperty
(name, value)
|
set string property value, for ML loaders |
showPopupMenu
(xx, yy)
|
shows popup menu at (x,y) |
updateActionState
(a, force, allowDefault)
|
ask for update state of some action (unles force=true, checks window flag actionsUpdateRequested), returns true if action state is changed |
updateActionState
(force)
|
call to update state for action (if action is assigned for widget) |
updateStateFromAction
(a)
|
apply enabled, visibile and checked state for this widget from action's state |
handleAction
(a)
|
override to handle specific actions |
calcScrollableAreaPos
()
|
calculate scrollable area info |
checkIfNeededToChangeScrollbarVisibility
()
|
|
checkIfScrollbarsNeeded
(needHScroll, needVScroll)
|
override to determine if scrollbars are needed or not |
colByAbsoluteX
(x)
|
column by X, ignoring scroll position |
correctScrollPos
()
|
|
drawCell
(buf, rc, col, row)
|
draw data cell content |
drawCellBackground
(buf, rc, col, row)
|
draw data cell background |
drawClient
(buf)
|
|
drawExtendedArea
(buf)
|
|
drawHeaderCell
(buf, rc, col, row)
|
draw header cell content |
drawHeaderCellBackground
(buf, rc, col, row)
|
draw header cell background |
endColResize
()
|
|
findPosIndex
(cumulativeSizes, pos)
|
search for index of position inside cumulative sizes array |
getCellPopupMenu
(col, row)
|
|
handleCheckChange
(checked)
|
override to handle check changes |
handleClick
()
|
|
handleClientRectLayout
(rc)
|
override to support modification of client rect after change, e.g. apply offset |
handleDoubleClick
()
|
|
handleFocusChange
(focused, receivedFocusFromKeyboard)
|
override to handle focus changes |
handleFontChanged
()
|
override to handle font changes |
lastScrollCol
()
|
returns last fully visible column in scroll area |
lastScrollRow
()
|
returns last fully visible row in scroll area |
measureCell
(x, y)
|
|
measureColWidth
(x)
|
|
measuredContent
(parentWidth, parentHeight, contentWidth, contentHeight)
|
helper function for implement measure() when widget's content dimensions are known |
measureRowHeight
(y)
|
|
onMenuItemAction
(action)
|
handle popup menu action |
processColResize
(x)
|
|
rowByAbsoluteY
(y)
|
row by Y, ignoring scroll position |
scrollCol
()
|
returns first fully visible column in scroll area |
scrollRow
()
|
returns first fully visible row in scroll area |
setWindowFocusedFlag
(flg)
|
|
startColResize
(col, x)
|
|
updateCumulativeSizes
()
|
recalculate colCumulativeWidths, rowCumulativeHeights after resizes |
updateHScrollBar
()
|
update horizontal scrollbar widget position |
updateScrollBars
()
|
update scrollbar positions |
updateVScrollBar
()
|
update verticat scrollbar widget position |
Aliases
| Name | Description |
|---|---|
~this
|