class KTabListBox

A multi column listbox Features: - User resizeable columns. More...

Definition#include <ktablistbox.h>
InheritsKDNDWidget (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Signals

Protected Methods

Protected Slots

Protected Members


Detailed Description

A multi column listbox Features: - User resizeable columns. - The order of columns can be changed with drag&drop. (Alex) - 3 modes: Standard, SimpleOrder, ComplexOrder. (Alex) ToDo: - Configurable vertical column divisor lines. - Save all setting to config file. - fix flickering into column headers.

enum ColumnType {TextColumn, PixmapColumn, MixedColumn }

enum OrderMode {Ascending, Descending }

enum OrderType {NoOrder, SimpleOrder, ComplexOrder }

 KTabListBox (QWidget *parent=0, const char *name=0, int columns=1, WFlags f=0)

KTabListBox ()

[virtual]

void  enableKey (void)

This enable the key-bindings (and set StrongFocus!) if you don't want StrongFocus you can implement your own keyPressEvent and send an event to KTabListBox from there...

uint  count (void)

[const]

Returns the number of rows

void  insertItem (const char* string, int itemIndex=-1)

[virtual]

Insert a line before given index, using the separator character to separate the fields. If no index is given the line is appended at the end. Returns index of inserted item.

void  appendStrList ( QStrList const *strLst )

Append a QStrList

void  appendItem (const char* string)

Same as insertItem, but always appends the new item.

void  changeItem (const char* string, int itemIndex)

[virtual]

Change contents of a line using the separator character to separate the fields.

void  changeItemPart (const char* string, int itemIndex, int column)

[virtual]

Change part of the contents of a line.

void  changeItemColor (const QColor& color, int itemIndex=-1)

[virtual]

Change color of line. Changes last inserted item when itemIndex==-1

int  tabWidth (void)

[const]

Get number of pixels one tab character stands for. Default: 10

void  setTabWidth (int)

[virtual]

Set number of pixels one tab character stands for. Default: 10

const QString&  text (int idx, int col=-1)

[const]

Returns contents of given row/column. If col is not set the contents of the whole row is returned, seperated with the current seperation character. In this case the string returned is a temporary string that will change on the next text() call on any KTabListBox object.

void  removeItem (int itemIndex)

[virtual]

Remove one item from the list.

void  clear (void)

[virtual]

Remove contents of listbox

int  currentItem (void)

[const]

Return index of current item

void  setCurrentItem (int idx, int colId=-1)

[virtual]

Set the current (selected) column. colId is the value that is transfered with the selected() signal that is emited.

void  unmarkAll (void)

[virtual]

Unmark all items

void  markItem (int idx, int colId=-1)

[virtual]

Mark/unmark item with index idx.

void  unmarkItem (int idx)

[virtual]

bool  isMarked (int idx)

[const virtual]

Returns TRUE if item with given index is marked.

int  findItem (int yPos)

[const]

Find item at given screen y position.

int  topItem (void)

[const]

Returns first item that is currently displayed in the widget.

void  setTopItem (int idx)

Change first displayed item by repositioning the visible part of the list.

void  setNumCols (int)

[virtual]

Set number of columns. Warning: this *deletes* the contents of the listbox.

void  setNumRows (int)

[virtual]

Set number of rows in the listbox. The contents stays as it is.

int  numRows (void)

[const]

See the docs for the QTableView class.

int  numCols (void)

[const]

See the docs for the QTableView class.

int  cellWidth (int col)

See the docs for the QTableView class.

int  totalWidth (void)

See the docs for the QTableView class.

int  cellHeight (int row)

See the docs for the QTableView class.

int  totalHeight (void)

See the docs for the QTableView class.

int  topCell (void)

[const]

See the docs for the QTableView class.

int  leftCell (void)

[const]

See the docs for the QTableView class.

int  lastColVisible (void)

[const]

See the docs for the QTableView class.

int  lastRowVisible (void)

[const]

See the docs for the QTableView class.

bool  autoUpdate (void)

[const]

See the docs for the QTableView class.

void  setAutoUpdate (bool upd)

See the docs for the QTableView class.

void  clearTableFlags (uint f=~0)

See the docs for the QTableView class.

uint  tableFlags (void)

See the docs for the QTableView class.

bool  testTableFlags (uint f)

See the docs for the QTableView class.

void  setTableFlags (uint f)

See the docs for the QTableView class.

int  findCol (int x)

See the docs for the QTableView class.

int  findRow (int y)

See the docs for the QTableView class.

bool  colXPos (int col, int* x)

See the docs for the QTableView class.

bool  rowYPos (int row, int* y)

See the docs for the QTableView class.

void  reorderRows ()

[virtual]

This call the 'compar' functions if they were been defined in setColumn or else use strcmp. (i.e. if you want a case-insensitive sort put strcasecmp in setColumn call). That compar function must take as arguments two char *, and must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

void  setColumn (int col, const char* caption, int width=0, ColumnType type=TextColumn, OrderType ordt=NoOrder, OrderMode omode=Descending, bool verticalLine=false, int (*compar)(const char *, const char *)=0L)

[virtual]

Set column caption, width, type,order-type and order-mode

void  setColumnWidth (int col, int width=0)

[virtual]

Set column width.

int  columnWidth (int col)

Get column width.

void  setDefaultColumnWidth (int width0, ...)

[virtual]

Set default width of all columns.

void  changeMode (int col)

change the Ascending/Descending mode of column col.

void  clearAllNum ()

Clear all number-check-buttons (ComplexOrder only)

void  setSeparator (char sep)

[virtual]

Set separator character, e.g. '\t'.

char  separator (void)

[const virtual]

Return separator character.

KTabListBoxDict&  dict (void)

For convenient access to the dictionary of pictures that this listbox understands.

void  repaint (void)

bool  startDrag (int col, int row, const QPoint& mousePos)

Indicates that a drag has started with given item. Returns TRUE if we are dragging, FALSE if drag-start failed.

Reimplemented from KDNDWidget.

QPixmap&  dndPixmap (void)

void  readConfig (void)

[virtual]

Read the config file entries in the group with the name of the listbox and set the default column widths and those.

void  writeConfig (void)

[virtual]

Write the config file entries in the group with the name of the listbox

int  colPosList (int num)

Return the actual position of the colum in the table.

int  itemPosList (int num)

Return the actual positon of the row number num.

const QFont&  tableFont (void)

[const]

Get/set font of the table. font() and setFont() apply to the caption only.

void  setTableFont (const QFont& fnt)

void  highlighted (int Index, int column)

[signal]

emited when the current item changes (either via setCurrentItem() or via mouse single-click).

void  selected (int Index, int column)

[signal]

emitted when the user double-clicks into a line.

void  popupMenu (int Index, int column)

[signal]

emitted when the user presses the right mouse button over a line.

void  midClick (int Index, int column)

[signal]

emitted when the user presses the middle mouse button over a line.

void  headerClicked (int column)

[signal]

emitted when the user clicks on a column header.

void  horSbValue (int val)

[protected slot]

void  horSbSlidingDone ()

[protected slot]

KTabListBoxColumn*  newKTabListBoxColumn (void)

[protected virtual]

Used to create new column objects. Overwrite this method in a subclass to have your own column objects (e.g. with custom data in it). You will then also need customData()/setCustomData() methods in here that access the elememts in itemList[].

bool  itemVisible (int idx)

[protected]

void  updateItem (int idx, bool clear = TRUE)

[protected]

bool  needsUpdate (int id)

[protected]

void  setCItem (int idx)

[protected]

void  adjustNumber (int num)

[protected]

void  flushKeys ()

[protected]

bool  recursiveSort (int level,int n,KTabListBoxColumn **c,int *iCol)

[protected]

KTabListBoxItem*  getItem (int idx)

[protected]

const KTabListBoxItem*  getItem (int idx)

[protected const]

void  keyPressEvent (QKeyEvent*)

[protected virtual]

void  resizeEvent (QResizeEvent*)

[protected virtual]

void  paintEvent (QPaintEvent*)

[protected virtual]

void  mouseMoveEvent (QMouseEvent*)

[protected virtual]

Reimplemented from KDNDWidget.

void  mousePressEvent (QMouseEvent*)

[protected virtual]

void  mouseReleaseEvent (QMouseEvent*)

[protected virtual]

Reimplemented from KDNDWidget.

void  resizeList (int newNumItems=-1)

[protected virtual]

Resize item array. Per default enlarge it to double size.

bool  prepareForDrag (int col, int row, char** data, int* size, int* type)

[protected virtual]

Called to set drag data, size, and type. If this method returns FALSE then no drag occurs.

void  doMouseResizeCol (QMouseEvent*)

[protected virtual]

Internal method that handles resizing of columns with the mouse.

void  doMouseMoveCol (QMouseEvent*)

[protected virtual]

Internal method that handles moving of columns with the mouse.

KTabListBoxColumn** colList

[protected]

int * colShowList

[protected]

int * itemShowList

[protected]

KTabListBoxItem** itemList

[protected]

int maxItems

[protected]

int numColumns

[protected]

int current

[protected]

char sepChar

[protected]

KTabListBoxDict pixDict

[protected]

KTabListBoxTable lbox

[protected]

int labelHeight

[protected]

QPixmap dndDefaultPixmap

[protected]

QPixmap upPix

[protected]

QPixmap downPix

[protected]

QPixmap disabledUpPix

[protected]

QPixmap disabledDownPix

[protected]

int columnPadding

[protected]

QColor highlightColor

[protected]

int tabPixels

[protected]

bool mResizeCol

[protected]

bool stopOrdering

[protected]

bool needsSort

[protected]

int lastSelectedColumn

[protected]

int nMarked

[protected]

int mSortCol

[protected]

int mMouseCol

[protected]

int mMouseColLeft

[protected]

int mLastX

[protected]

int mMouseColWidth

[protected]

QPoint mMouseStart

[protected]

bool mMouseAction

[protected]

bool mMouseDragColumn

[protected]


Generated by: prospector@porky.devel.redhat.com on Mon Sep 11 01:50:57 2000, using kdoc 2.0a36.