From 7028cbe09c688437910a25623098762bf0fa592d Mon Sep 17 00:00:00 2001 From: David Walter Seikel Date: Mon, 28 Mar 2016 22:28:34 +1000 Subject: Move Irrlicht to src/others. --- .../html/classirr_1_1gui_1_1_i_g_u_i_table.html | 940 +++++++++++++++++++++ 1 file changed, 940 insertions(+) create mode 100644 src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_table.html (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_table.html') diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_table.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_table.html new file mode 100644 index 0000000..008add1 --- /dev/null +++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_table.html @@ -0,0 +1,940 @@ + + + + +Irrlicht 3D Engine: irr::gui::IGUITable Class Reference + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + +
+
Irrlicht 3D Engine + +
+ +
+ + + + + + +
+
+
+ + + + +
+
+ +
+
+
+ +
+
+
+Public Member Functions
+
+
irr::gui::IGUITable Class Reference
+
+
+ +

Default list box GUI element. + More...

+ +

#include <IGUITable.h>

+
+ + Inheritance diagram for irr::gui::IGUITable:
+
+
+ + +

List of all members.

+

+Public Member Functions

+ +

Detailed Description

+

Default list box GUI element.

+
This element can create the following events of type EGUI_EVENT_TYPE:
    +
  • EGET_TABLE_CHANGED
    • +
  • EGET_TABLE_SELECTED_AGAIN
    • +
  • EGET_TABLE_HEADER_CHANGED
    • +
+
+ +

Definition at line 89 of file IGUITable.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
irr::gui::IGUITable::IGUITable (IGUIEnvironment * environment,
IGUIElement * parent,
s32 id,
core::rect< s32 > rectangle 
) [inline]
+
+
+ +

constructor

+ +

Definition at line 93 of file IGUITable.h.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::addColumn (const wchar_t * caption,
s32 columnIndex = -1 
) [pure virtual]
+
+
+ +

Adds a column.

+

If columnIndex is outside the current range, do push new colum at the end

+ +
+
+ +
+
+ + + + + + + + +
virtual u32 irr::gui::IGUITable::addRow (u32 rowIndex) [pure virtual]
+
+
+ +

adds a row to the table

+
Parameters:
+ + +
rowIndexZero based index of rows. The row will be inserted at this position, if a row already exist there, it will be placed after it. If the row is larger than the actual number of row by more than one, it won't be created. Note that if you create a row that's not at the end, there might be performance issues.
+
+
+
Returns:
index of inserted row.
+ +
+
+ +
+
+ + + + + + + +
virtual void irr::gui::IGUITable::clear () [pure virtual]
+
+
+ +

clears the table, deletes all items in the table

+ +
+
+ +
+
+ + + + + + + +
virtual void irr::gui::IGUITable::clearRows () [pure virtual]
+
+
+ +

clears the table rows, but keeps the columns intact

+ +
+
+ +
+
+ + + + + + + +
virtual s32 irr::gui::IGUITable::getActiveColumn () const [pure virtual]
+
+
+ +

Returns which header is currently active.

+ +
+
+ +
+
+ + + + + + + +
virtual EGUI_ORDERING_MODE irr::gui::IGUITable::getActiveColumnOrdering () const [pure virtual]
+
+
+ +

Returns the ordering used by the currently active column.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual void* irr::gui::IGUITable::getCellData (u32 rowIndex,
u32 columnIndex 
) const [pure virtual]
+
+
+ +

Get the data of a cell.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual const wchar_t* irr::gui::IGUITable::getCellText (u32 rowIndex,
u32 columnIndex 
) const [pure virtual]
+
+
+ +

Get the text of a cell.

+ +
+
+ +
+
+ + + + + + + +
virtual s32 irr::gui::IGUITable::getColumnCount () const [pure virtual]
+
+
+ +

Returns the number of columns in the table control.

+ +
+
+ +
+
+ + + + + + + + +
virtual u32 irr::gui::IGUITable::getColumnWidth (u32 columnIndex) const [pure virtual]
+
+
+ +

Get the width of a column.

+ +
+
+ +
+
+ + + + + + + +
virtual s32 irr::gui::IGUITable::getDrawFlags () const [pure virtual]
+
+
+ +

Get the flags, as defined in EGUI_TABLE_DRAW_FLAGS, which influence the layout.

+ +
+
+ +
+
+ + + + + + + +
virtual s32 irr::gui::IGUITable::getRowCount () const [pure virtual]
+
+
+ +

Get amount of rows in the tabcontrol.

+ +
+
+ +
+
+ + + + + + + +
virtual s32 irr::gui::IGUITable::getSelected () const [pure virtual]
+
+
+ +

Returns which row is currently selected.

+ +
+
+ +
+
+ + + + + + + +
virtual bool irr::gui::IGUITable::hasResizableColumns () const [pure virtual]
+
+
+ +

can columns be resized by dran 'n drop?

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::orderRows (s32 columnIndex = -1,
EGUI_ORDERING_MODE mode = EGOM_NONE 
) [pure virtual]
+
+
+ +

This tells the table to start ordering all the rows.

+

You need to explicitly tell the table to re order the rows when a new row is added or the cells data is changed. This makes the system more flexible and doesn't make you pay the cost of ordering when adding a lot of rows.

+
Parameters:
+ + + +
columnIndex,:When set to -1 the active column is used.
modeOrdering mode of the rows.
+
+
+ +
+
+ +
+
+ + + + + + + + +
virtual void irr::gui::IGUITable::removeColumn (u32 columnIndex) [pure virtual]
+
+
+ +

remove a column from the table

+ +
+
+ +
+
+ + + + + + + + +
virtual void irr::gui::IGUITable::removeRow (u32 rowIndex) [pure virtual]
+
+
+ +

Remove a row from the table.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual bool irr::gui::IGUITable::setActiveColumn (s32 idx,
bool doOrder = false 
) [pure virtual]
+
+
+ +

Makes a column active. This will trigger an ordering process.

+
Parameters:
+ + + +
idx,:The id of the column to make active.
doOrder,:Do also the ordering which depending on mode for active column
+
+
+
Returns:
True if successful.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::setCellColor (u32 rowIndex,
u32 columnIndex,
video::SColor color 
) [pure virtual]
+
+
+ +

Set the color of a cell text.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::setCellData (u32 rowIndex,
u32 columnIndex,
void * data 
) [pure virtual]
+
+
+ +

Set the data of a cell.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::setCellText (u32 rowIndex,
u32 columnIndex,
const core::stringw & text 
) [pure virtual]
+
+
+ +

Set the text of a cell.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::setCellText (u32 rowIndex,
u32 columnIndex,
const core::stringw & text,
video::SColor color 
) [pure virtual]
+
+
+ +

Set the text of a cell, and set a color of this cell.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::setColumnOrdering (u32 columnIndex,
EGUI_COLUMN_ORDERING mode 
) [pure virtual]
+
+
+ +

This tells the table control which ordering mode should be used when a column header is clicked.

+
Parameters:
+ + + +
columnIndexThe index of the column header.
mode,:One of the modes defined in EGUI_COLUMN_ORDERING
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::setColumnWidth (u32 columnIndex,
u32 width 
) [pure virtual]
+
+
+ +

Set the width of a column.

+ +
+
+ +
+
+ + + + + + + + +
virtual void irr::gui::IGUITable::setDrawFlags (s32 flags) [pure virtual]
+
+
+ +

Set flags, as defined in EGUI_TABLE_DRAW_FLAGS, which influence the layout.

+ +
+
+ +
+
+ + + + + + + + +
virtual void irr::gui::IGUITable::setResizableColumns (bool resizable) [pure virtual]
+
+
+ +

columns can be resized by drag 'n drop

+ +
+
+ +
+
+ + + + + + + + +
virtual void irr::gui::IGUITable::setSelected (s32 index) [pure virtual]
+
+
+ +

set wich row is currently selected

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual void irr::gui::IGUITable::swapRows (u32 rowIndexA,
u32 rowIndexB 
) [pure virtual]
+
+
+ +

Swap two row positions.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + + -- cgit v1.1