Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXTable Class Reference

Table Widget. More...

#include <FXTable.h>

Inheritance diagram for FX::FXTable:

FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject List of all members.

Public Member Functions

 FXTable (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_MARGIN, FXint pr=DEFAULT_MARGIN, FXint pt=DEFAULT_MARGIN, FXint pb=DEFAULT_MARGIN)
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()
virtual void create ()
virtual void detach ()
virtual void layout ()
virtual void recalc ()
virtual FXbool canFocus () const
virtual void setFocus ()
virtual void killFocus ()
FXHeader * getColumnHeader () const
FXHeader * getRowHeader () const
void setVisibleRows (FXint nvrows)
FXint getVisibleRows () const
void setVisibleColumns (FXint nvcols)
FXint getVisibleColumns () const
void showHorzGrid (FXbool on=TRUE)
FXbool isHorzGridShown () const
void showVertGrid (FXbool on=TRUE)
FXbool isVertGridShown () const
FXint getNumRows () const
FXint getNumColumns () const
void setMarginTop (FXint pt)
FXint getMarginTop () const
void setMarginBottom (FXint pb)
FXint getMarginBottom () const
void setMarginLeft (FXint pl)
FXint getMarginLeft () const
void setMarginRight (FXint pr)
FXint getMarginRight () const
FXint rowAtY (FXint y) const
FXint colAtX (FXint x) const
FXTableItem * getItem (FXint row, FXint col) const
void setItem (FXint row, FXint col, FXTableItem *item, FXbool notify=FALSE)
virtual void setTableSize (FXint nr, FXint nc, FXbool notify=FALSE)
virtual void insertRows (FXint row, FXint nr=1, FXbool notify=FALSE)
virtual void insertColumns (FXint col, FXint nc=1, FXbool notify=FALSE)
virtual void removeRows (FXint row, FXint nr=1, FXbool notify=FALSE)
virtual void removeColumns (FXint col, FXint nc=1, FXbool notify=FALSE)
virtual void removeItem (FXint row, FXint col, FXbool notify=FALSE)
virtual void removeRange (FXint startrow, FXint endrow, FXint startcol, FXint endcol, FXbool notify=FALSE)
virtual void clearItems (FXbool notify=FALSE)
void makePositionVisible (FXint r, FXint c)
FXbool isItemVisible (FXint r, FXint c) const
void setColumnHeaderMode (FXuint hint=LAYOUT_FIX_HEIGHT)
FXuint getColumnHeaderMode () const
void setRowHeaderMode (FXuint hint=LAYOUT_FIX_WIDTH)
FXuint getRowHeaderMode () const
void setColumnHeaderHeight (FXint h)
FXint getColumnHeaderHeight () const
void setRowHeaderWidth (FXint w)
FXint getRowHeaderWidth () const
virtual void setColumnWidth (FXint col, FXint cwidth)
FXint getColumnWidth (FXint col) const
virtual void setRowHeight (FXint row, FXint rheight)
FXint getRowHeight (FXint row) const
virtual void setColumnX (FXint col, FXint x)
FXint getColumnX (FXint col) const
virtual void setRowY (FXint row, FXint y)
FXint getRowY (FXint row) const
void setDefColumnWidth (FXint cwidth)
FXint getDefColumnWidth () const
void setDefRowHeight (FXint rheight)
FXint getDefRowHeight () const
FXint getMinRowHeight (FXint r) const
FXint getMinColumnWidth (FXint c) const
void setColumnText (FXint index, const FXString &text)
FXString getColumnText (FXint index) const
void setRowText (FXint index, const FXString &text)
FXString getRowText (FXint index) const
void setItemText (FXint r, FXint c, const FXString &text)
FXString getItemText (FXint r, FXint c) const
void setItemIcon (FXint r, FXint c, FXIcon *icon)
FXIcon * getItemIcon (FXint r, FXint c) const
void setItemData (FXint r, FXint c, void *ptr)
void * getItemData (FXint r, FXint c) const
void extractText (FXchar *&text, FXint &size, FXint startrow, FXint endrow, FXint startcol, FXint endcol, FXchar cs='\t', FXchar rs='\n') const
void overlayText (FXint startrow, FXint endrow, FXint startcol, FXint endcol, const FXchar *text, FXint size, FXchar cs='\t', FXchar rs='\n')
FXbool isItemSpanning (FXint r, FXint c) const
void updateRange (FXint sr, FXint er, FXint sc, FXint ec) const
void updateItem (FXint r, FXint c) const
FXbool enableItem (FXint r, FXint c)
FXbool disableItem (FXint r, FXint c)
FXbool isItemEnabled (FXint r, FXint c) const
void setItemJustify (FXint r, FXint c, FXuint justify)
FXuint getItemJustify (FXint r, FXint c) const
void setItemIconPosition (FXint r, FXint c, FXuint mode)
FXuint getItemIconPosition (FXint r, FXint c) const
void setItemBorders (FXint r, FXint c, FXuint borders)
FXuint getItemBorders (FXint r, FXint c) const
void setItemStipple (FXint r, FXint c, FXStipplePattern pat)
FXStipplePattern getItemStipple (FXint r, FXint c) const
virtual void setCurrentItem (FXint r, FXint c, FXbool notify=FALSE)
FXint getCurrentRow () const
FXint getCurrentColumn () const
FXbool isItemCurrent (FXint r, FXint c) const
void setAnchorItem (FXint r, FXint c)
FXint getAnchorRow () const
FXint getAnchorColumn () const
FXint getSelStartRow () const
FXint getSelStartColumn () const
FXint getSelEndRow () const
FXint getSelEndColumn () const
FXbool isItemSelected (FXint r, FXint c) const
FXbool isRowSelected (FXint r) const
FXbool isColumnSelected (FXint c) const
FXbool isAnythingSelected () const
virtual FXbool selectRow (FXint row, FXbool notify=FALSE)
virtual FXbool selectColumn (FXint col, FXbool notify=FALSE)
virtual FXbool selectRange (FXint startrow, FXint endrow, FXint startcol, FXint endcol, FXbool notify=FALSE)
virtual FXbool extendSelection (FXint r, FXint c, FXbool notify=FALSE)
virtual FXbool killSelection (FXbool notify=FALSE)
void setFont (FXFont *fnt)
FXFont * getFont () const
FXColor getTextColor () const
FXColor getBaseColor () const
FXColor getHiliteColor () const
FXColor getShadowColor () const
FXColor getBorderColor () const
FXColor getSelBackColor () const
FXColor getSelTextColor () const
FXColor getGridColor () const
FXColor getStippleColor () const
FXColor getCellBorderColor () const
void setTextColor (FXColor clr)
void setBaseColor (FXColor clr)
void setHiliteColor (FXColor clr)
void setShadowColor (FXColor clr)
void setBorderColor (FXColor clr)
void setSelBackColor (FXColor clr)
void setSelTextColor (FXColor clr)
void setGridColor (FXColor clr)
void setStippleColor (FXColor clr)
void setCellBorderColor (FXColor clr)
void setCellColor (FXint r, FXint c, FXColor clr)
FXColor getCellColor (FXint r, FXint c) const
void setCellBorderWidth (FXint borderwidth)
FXint getCellBorderWidth () const
void setTableStyle (FXuint style)
FXuint getTableStyle () const
void setHelpText (const FXString &text)
FXString getHelpText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)

Static Public Attributes

FXDragType csvType
const FXchar csvTypeName []

Detailed Description

Table Widget.

See also:

Constructor & Destructor Documentation

FX::FXTable::FXTable (  FXComposite *  p,
FXObject *  tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0,
FXint  pl = DEFAULT_MARGIN,
FXint  pr = DEFAULT_MARGIN,
FXint  pt = DEFAULT_MARGIN,
FXint  pb = DEFAULT_MARGIN
) 
 

Construct a new table.

The table is initially empty, and reports a default size based on the scroll areas's scrollbar placement policy.

Member Function Documentation

virtual FXint FX::FXTable::getDefaultWidth (   )  [virtual]
 

Return default width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTable::getDefaultHeight (   )  [virtual]
 

Return default height.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTable::getContentWidth (   )  [virtual]
 

Computes content width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXTable::getContentHeight (   )  [virtual]
 

Computes content height.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXTable::create (   )  [virtual]
 

Create the server-side resources.

Reimplemented from FX::FXComposite.

virtual void FX::FXTable::detach (   )  [virtual]
 

Detach the server-side resources.

Reimplemented from FX::FXComposite.

virtual void FX::FXTable::layout (   )  [virtual]
 

Perform layout.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXTable::recalc (   )  [virtual]
 

Mark this window's layout as dirty.

Reimplemented from FX::FXWindow.

virtual FXbool FX::FXTable::canFocus (   )  const [virtual]
 

Table widget can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXTable::setFocus (   )  [virtual]
 

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXTable::killFocus (   )  [virtual]
 

Remove the focus from this window.

Reimplemented from FX::FXWindow.

FXHeader* FX::FXTable::getColumnHeader (   )  const [inline]
 

Return column header control.

FXHeader* FX::FXTable::getRowHeader (   )  const [inline]
 

Return row header control.

void FX::FXTable::setVisibleRows (  FXint  nvrows  ) 
 

Change visible rows/columns.

void FX::FXTable::showHorzGrid (  FXbool  on = TRUE  ) 
 

Show or hide horizontal grid.

FXbool FX::FXTable::isHorzGridShown (   )  const [inline]
 

Is horizontal grid shown.

void FX::FXTable::showVertGrid (  FXbool  on = TRUE  ) 
 

Show or hide vertical grid.

FXbool FX::FXTable::isVertGridShown (   )  const [inline]
 

Is vertical grid shown.

FXint FX::FXTable::getNumRows (   )  const [inline]
 

Get number of rows.

FXint FX::FXTable::getNumColumns (   )  const [inline]
 

Get number of columns.

void FX::FXTable::setMarginTop (  FXint  pt  ) 
 

Change top cell margin.

FXint FX::FXTable::getMarginTop (   )  const [inline]
 

Return top cell margin.

void FX::FXTable::setMarginBottom (  FXint  pb  ) 
 

Change bottom cell margin.

FXint FX::FXTable::getMarginBottom (   )  const [inline]
 

Return bottom cell margin.

void FX::FXTable::setMarginLeft (  FXint  pl  ) 
 

Change left cell margin.

FXint FX::FXTable::getMarginLeft (   )  const [inline]
 

Return left cell margin.

void FX::FXTable::setMarginRight (  FXint  pr  ) 
 

Change right cell margin.

FXint FX::FXTable::getMarginRight (   )  const [inline]
 

Return right cell margin.

FXint FX::FXTable::rowAtY (  FXint  y  )  const
 

Determine row containing y.

Returns -1 if y above first row, and nrows if y below last row; otherwise, returns row in table containing y.

FXint FX::FXTable::colAtX (  FXint  x  )  const
 

Determine column containing x.

Returns -1 if x left of first column, and ncols if x right of last column; otherwise, returns columns in table containing x.

FXTableItem* FX::FXTable::getItem (  FXint  row,
FXint  col
)  const
 

Return the item at the given index.

void FX::FXTable::setItem (  FXint  row,
FXint  col,
FXTableItem *  item,
FXbool  notify = FALSE
) 
 

Replace the item with a [possibly subclassed] item.

virtual void FX::FXTable::setTableSize (  FXint  nr,
FXint  nc,
FXbool  notify = FALSE
)  [virtual]
 

Set the table size to nr rows and nc columns; all existing items will be removed.

virtual void FX::FXTable::insertRows (  FXint  row,
FXint  nr = 1,
FXbool  notify = FALSE
)  [virtual]
 

Insert new row.

virtual void FX::FXTable::insertColumns (  FXint  col,
FXint  nc = 1,
FXbool  notify = FALSE
)  [virtual]
 

Insert new column.

virtual void FX::FXTable::removeRows (  FXint  row,
FXint  nr = 1,
FXbool  notify = FALSE
)  [virtual]
 

Remove rows of cells.

virtual void FX::FXTable::removeColumns (  FXint  col,
FXint  nc = 1,
FXbool  notify = FALSE
)  [virtual]
 

Remove column of cells.

virtual void FX::FXTable::removeItem (  FXint  row,
FXint  col,
FXbool  notify = FALSE
)  [virtual]
 

Clear single cell.

virtual void FX::FXTable::removeRange (  FXint  startrow,
FXint  endrow,
FXint  startcol,
FXint  endcol,
FXbool  notify = FALSE
)  [virtual]
 

Clear all cells in the given range.

virtual void FX::FXTable::clearItems (  FXbool  notify = FALSE  )  [virtual]
 

Remove all items from table.

void FX::FXTable::makePositionVisible (  FXint  r,
FXint  c
) 
 

Scroll to make cell at r,c fully visible.

void FX::FXTable::setColumnHeaderMode (  FXuint  hint = LAYOUT_FIX_HEIGHT  ) 
 

Change column header height mode to fixed or variable.

In variable height mode, the column header will size to fit the contents in it. In fixed mode, the size is explicitly set using setColumnHeaderHeight().

FXuint FX::FXTable::getColumnHeaderMode (   )  const
 

Return column header height mode.

void FX::FXTable::setRowHeaderMode (  FXuint  hint = LAYOUT_FIX_WIDTH  ) 
 

Change row header width mode to fixed or variable.

In variable width mode, the row header will size to fit the contents in it. In fixed mode, the size is explicitly set using setRowHeaderWidth().

FXuint FX::FXTable::getRowHeaderMode (   )  const
 

Return row header width mode.

void FX::FXTable::setColumnHeaderHeight (  FXint  h  ) 
 

Change column header height.

FXint FX::FXTable::getColumnHeaderHeight (   )  const
 

Return column header height.

void FX::FXTable::setRowHeaderWidth (  FXint  w  ) 
 

Change row header width.

FXint FX::FXTable::getRowHeaderWidth (   )  const
 

Return row header width.

virtual void FX::FXTable::setColumnWidth (  FXint  col,
FXint  cwidth
)  [virtual]
 

Change column width.

virtual void FX::FXTable::setRowHeight (  FXint  row,
FXint  rheight
)  [virtual]
 

Change row height.

virtual void FX::FXTable::setColumnX (  FXint  col,
FXint  x
)  [virtual]
 

Change X coordinate of column c.

virtual void FX::FXTable::setRowY (  FXint  row,
FXint  y
)  [virtual]
 

Change Y coordinate of row r.

void FX::FXTable::setDefColumnWidth (  FXint  cwidth  ) 
 

Change default column width.

void FX::FXTable::setDefRowHeight (  FXint  rheight  ) 
 

Change default row height.

FXint FX::FXTable::getMinRowHeight (  FXint  r  )  const
 

Return minimum row height.

FXint FX::FXTable::getMinColumnWidth (  FXint  c  )  const
 

Return minimum column width.

void FX::FXTable::setColumnText (  FXint  index,
const FXString &  text
) 
 

Change column header.

FXString FX::FXTable::getColumnText (  FXint  index  )  const
 

Return text of column header at index.

void FX::FXTable::setRowText (  FXint  index,
const FXString &  text
) 
 

Change row header.

FXString FX::FXTable::getRowText (  FXint  index  )  const
 

Return text of row header at index.

void FX::FXTable::setItemText (  FXint  r,
FXint  c,
const FXString &  text
) 
 

Modify cell text.

void FX::FXTable::setItemIcon (  FXint  r,
FXint  c,
FXIcon *  icon
) 
 

Modify cell icon.

void FX::FXTable::setItemData (  FXint  r,
FXint  c,
void *  ptr
) 
 

Modify cell user-data.

void FX::FXTable::extractText (  FXchar *&  text,
FXint &  size,
FXint  startrow,
FXint  endrow,
FXint  startcol,
FXint  endcol,
FXchar  cs = '\t',
FXchar  rs = '\n'
)  const
 

Extract cells from given range as text.

void FX::FXTable::overlayText (  FXint  startrow,
FXint  endrow,
FXint  startcol,
FXint  endcol,
const FXchar *  text,
FXint  size,
FXchar  cs = '\t',
FXchar  rs = '\n'
) 
 

Overlay text over given cell range.

FXbool FX::FXTable::isItemSpanning (  FXint  r,
FXint  c
)  const
 

Return TRUE if its a spanning cell.

void FX::FXTable::updateRange (  FXint  sr,
FXint  er,
FXint  sc,
FXint  ec
)  const
 

Repaint cells between grid lines sr,er and grid lines sc,ec.

void FX::FXTable::updateItem (  FXint  r,
FXint  c
)  const
 

Repaint cell at r,c.

FXbool FX::FXTable::enableItem (  FXint  r,
FXint  c
) 
 

Enable item.

FXbool FX::FXTable::disableItem (  FXint  r,
FXint  c
) 
 

Disable item.

void FX::FXTable::setItemJustify (  FXint  r,
FXint  c,
FXuint  justify
) 
 

Change item justification.

FXuint FX::FXTable::getItemJustify (  FXint  r,
FXint  c
)  const
 

Return item justification.

void FX::FXTable::setItemIconPosition (  FXint  r,
FXint  c,
FXuint  mode
) 
 

Change relative position of icon and text of item.

FXuint FX::FXTable::getItemIconPosition (  FXint  r,
FXint  c
)  const
 

Return relative icon and text position.

void FX::FXTable::setItemBorders (  FXint  r,
FXint  c,
FXuint  borders
) 
 

Change item border style.

FXuint FX::FXTable::getItemBorders (  FXint  r,
FXint  c
)  const
 

Return item border style.

void FX::FXTable::setItemStipple (  FXint  r,
FXint  c,
FXStipplePattern  pat
) 
 

Change item background stipple style.

FXStipplePattern FX::FXTable::getItemStipple (  FXint  r,
FXint  c
)  const
 

return item background stipple style

virtual void FX::FXTable::setCurrentItem (  FXint  r,
FXint  c,
FXbool  notify = FALSE
)  [virtual]
 

Change current item.

FXint FX::FXTable::getCurrentRow (   )  const [inline]
 

Get row number of current item.

FXint FX::FXTable::getCurrentColumn (   )  const [inline]
 

Get column number of current item.

void FX::FXTable::setAnchorItem (  FXint  r,
FXint  c
) 
 

Change anchor item.

FXint FX::FXTable::getAnchorRow (   )  const [inline]
 

Get row number of anchor item.

FXint FX::FXTable::getAnchorColumn (   )  const [inline]
 

Get column number of anchor item.

FXint FX::FXTable::getSelStartRow (   )  const [inline]
 

Get selection start row; returns -1 if no selection.

FXint FX::FXTable::getSelStartColumn (   )  const [inline]
 

Get selection start column; returns -1 if no selection.

FXint FX::FXTable::getSelEndRow (   )  const [inline]
 

Get selection end row; returns -1 if no selection.

FXint FX::FXTable::getSelEndColumn (   )  const [inline]
 

Get selection end column; returns -1 if no selection.

FXbool FX::FXTable::isItemSelected (  FXint  r,
FXint  c
)  const
 

Is cell selected.

FXbool FX::FXTable::isRowSelected (  FXint  r  )  const
 

Is row of cells selected.

FXbool FX::FXTable::isColumnSelected (  FXint  c  )  const
 

Is column selected.

FXbool FX::FXTable::isAnythingSelected (   )  const
 

Is anything selected.

virtual FXbool FX::FXTable::selectRow (  FXint  row,
FXbool  notify = FALSE
)  [virtual]
 

Select a row.

virtual FXbool FX::FXTable::selectColumn (  FXint  col,
FXbool  notify = FALSE
)  [virtual]
 

Select a column.

virtual FXbool FX::FXTable::selectRange (  FXint  startrow,
FXint  endrow,
FXint  startcol,
FXint  endcol,
FXbool  notify = FALSE
)  [virtual]
 

Select range.

virtual FXbool FX::FXTable::extendSelection (  FXint  r,
FXint  c,
FXbool  notify = FALSE
)  [virtual]
 

Extend selection.

virtual FXbool FX::FXTable::killSelection (  FXbool  notify = FALSE  )  [virtual]
 

Kill selection.

void FX::FXTable::setFont (  FXFont *  fnt  ) 
 

Change font.

FXFont* FX::FXTable::getFont (   )  const [inline]
 

Return current font.

FXColor FX::FXTable::getTextColor (   )  const [inline]
 

Obtain colors of various parts.

void FX::FXTable::setTextColor (  FXColor  clr  ) 
 

Change colors of various parts.

void FX::FXTable::setCellColor (  FXint  r,
FXint  c,
FXColor  clr
) 
 

Change cell background color for even/odd rows/columns.

FXColor FX::FXTable::getCellColor (  FXint  r,
FXint  c
)  const
 

Obtain cell background color for even/odd rows/columns.

void FX::FXTable::setCellBorderWidth (  FXint  borderwidth  ) 
 

Change cell border width.

FXint FX::FXTable::getCellBorderWidth (   )  const [inline]
 

Return cell border width.

void FX::FXTable::setTableStyle (  FXuint  style  ) 
 

Change table style.

FXuint FX::FXTable::getTableStyle (   )  const
 

Return table style.

void FX::FXTable::setHelpText (  const FXString &  text  )  [inline]
 

Change help text.

virtual void FX::FXTable::save (  FXStream &  store  )  const [virtual]
 

Serialize.

Reimplemented from FX::FXWindow.

virtual void FX::FXTable::load (  FXStream &  store  )  [virtual]
 

Restore window from stream.

Reimplemented from FX::FXWindow.

Copyright © 1997-2004 Jeroen van der Zijp