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

FX::FXTable

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 bool canFocus () const
virtual void setFocus ()
virtual void killFocus ()
virtual void changeFocus (FXWindow *child)
FXButton * getCornerButton () const
FXHeader * getColumnHeader () const
FXHeader * getRowHeader () const
void setVisibleRows (FXint nvrows)
FXint getVisibleRows () const
void setVisibleColumns (FXint nvcols)
FXint getVisibleColumns () const
FXbool isEditable () const
void setEditable (FXbool edit=TRUE)
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
virtual void startInput (FXint row, FXint col)
virtual void cancelInput ()
virtual void acceptInput (FXbool notify=FALSE)
FXint colAtX (FXint x) const
FXint rowAtY (FXint y) 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 FXTableItem * extractItem (FXint row, FXint col, 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)
virtual 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 setColumnHeaderFont (FXFont *fnt)
FXFont * getColumnHeaderFont () const
void setRowHeaderFont (FXFont *fnt)
FXFont * getRowHeaderFont () const
void setColumnHeaderHeight (FXint h)
FXint getColumnHeaderHeight () const
void setRowHeaderWidth (FXint w)
FXint getRowHeaderWidth () const
FXint getColumnX (FXint col) const
FXint getRowY (FXint row) 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
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 fitRowsToContents (FXint row, FXint nr=1)
void fitColumnsToContents (FXint col, FXint nc=1)
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 setColumnIcon (FXint index, FXIcon *icon)
FXIcon * getColumnIcon (FXint index) const
void setRowIcon (FXint index, FXIcon *icon)
FXIcon * getRowIcon (FXint index) const
void setColumnIconPosition (FXint index, FXuint mode)
FXuint getColumnIconPosition (FXint index) const
void setRowIconPosition (FXint index, FXuint mode)
FXuint getRowIconPosition (FXint index) const
void setColumnJustify (FXint index, FXuint justify)
FXuint getColumnJustify (FXint index) const
void setRowJustify (FXint index, FXuint justify)
FXuint getRowJustify (FXint index) const
void setItemText (FXint r, FXint c, const FXString &text, FXbool notify=FALSE)
FXString getItemText (FXint r, FXint c) const
void setItemIcon (FXint r, FXint c, FXIcon *icon, FXbool owned=FALSE, FXbool notify=FALSE)
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, const FXchar *cs="\t", const FXchar *rs="\n") const
void extractText (FXString &text, FXint startrow, FXint endrow, FXint startcol, FXint endcol, const FXchar *cs="\t", const FXchar *rs="\n") const
void overlayText (FXint startrow, FXint endrow, FXint startcol, FXint endcol, const FXchar *text, FXint size, const FXchar *cs="\t,", const FXchar *rs="\n", FXbool notify=FALSE)
void overlayText (FXint startrow, FXint endrow, FXint startcol, FXint endcol, const FXString &text, const FXchar *cs="\t,", const FXchar *rs="\n", FXbool notify=FALSE)
void countText (FXint &nr, FXint &nc, const FXchar *text, FXint size, const FXchar *cs="\t,", const FXchar *rs="\n") const
void countText (FXint &nr, FXint &nc, const FXString &text, const FXchar *cs="\t,", const FXchar *rs="\n") const
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
virtual FXbool enableItem (FXint r, FXint c)
virtual 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 setColumnRenumbering (FXbool flag)
FXbool getColumnRenumbering () const
void setRowRenumbering (FXbool flag)
FXbool getRowRenumbering () const
void setHelpText (const FXString &text)
const FXString & getHelpText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXTable ()

Static Public Attributes

static FXDragType csvType
static 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.

virtual FX::FXTable::~FXTable (   )  [virtual]
 

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 bool 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.

virtual void FX::FXTable::changeFocus (  FXWindow *  child  )  [virtual]
 

Notification that focus moved to new child.

Reimplemented from FX::FXWindow.

FXButton* FX::FXTable::getCornerButton (   )  const [inline]
 

Return button in the top/left corner.

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.

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

return number of visible rows

void FX::FXTable::setVisibleColumns (  FXint  nvcols  ) 
 

Change visible columns.

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

Return number of visible columns.

FXbool FX::FXTable::isEditable (   )  const
 

Return TRUE if table is editable.

void FX::FXTable::setEditable (  FXbool  edit = TRUE  ) 
 

Set editable flag.

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.

virtual void FX::FXTable::startInput (  FXint  row,
FXint  col
)  [virtual]
 

Start input mode for the cell at the given position.

An input control is created which is used to edit the cell; it is filled by the original item's contents if the cell contained an item. You can enter input mode also by sending the table an ID_START_INPUT message.

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

Cancel input mode.

The input control is immediately deleted and the cell will retain its old value. You can also cancel input mode by sending the table an ID_CANCEL_INPUT message.

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

End input mode and accept the new value from the control.

The item in the cell will be set to the value from the control, and the control will be deleted. If TRUE is passed, a SEL_REPLACED callback will be generated to signify to the target that this call has a new value. You can also accept the input by sending the table an ID_ACCEPT_INPUT message.

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 column in table containing x.

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.

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 FXTableItem* FX::FXTable::extractItem (  FXint  row,
FXint  col,
FXbool  notify = FALSE
)  [virtual]
 

Extract item from table.

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.

virtual void FX::FXTable::makePositionVisible (  FXint  r,
FXint  c
)  [virtual]
 

Scroll to make cell at r,c fully visible.

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

Return TRUE if item partially 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::setColumnHeaderFont (  FXFont *  fnt  ) 
 

Set column header font.

FXFont* FX::FXTable::getColumnHeaderFont (   )  const
 

Return column header font.

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

Set row header font.

FXFont* FX::FXTable::getRowHeaderFont (   )  const
 

Return row header font.

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.

FXint FX::FXTable::getColumnX (  FXint  col  )  const