TableTree

A TableTree is a selectable user interface object that displays a hierarchy of items, and issues notification when an item is selected. A TableTree may be single or multi select. <p> The item children that may be added to instances of this class must be of type <code>TableTreeItem</code>. </p><p> Note that although this class is a subclass of <code>Composite</code>, it does not make sense to add <code>Control</code> children to it, or set a layout on it. </p><p> <dl> <dt><b>Styles:</b> <dd> SINGLE, MULTI, CHECK, FULL_SELECTION <dt><b>Events:</b> <dd> Selection, DefaultSelection, Collapse, Expand </dl> <p> Note: Only one of the styles SINGLE, and MULTI may be specified. </p>

@deprecated As of 3.1 use Tree, TreeItem and TreeColumn

class TableTree : Composite {

alias computeSize = Composite.computeSize;

TableTreeItem[] items;

Image plusImage;

Image minusImage;

Image sizeImage;

bool inDispose;

TableTreeItem[] EMPTY_ITEMS;

String[] EMPTY_TEXTS;

Image[] EMPTY_IMAGES;

String ITEMID;

this(Composite parent, int style);

int addItem(TableTreeItem item, int index);

void addSelectionListener(SelectionListener listener);

void addTreeListener(TreeListener listener);

Point computeSize(int wHint, int hHint, bool changed);

Rectangle computeTrim(int x, int y, int width, int height);

void deselectAll();

void expandItem(TableTreeItem item);

Color getBackground();

Rectangle getClientArea();

Color getForeground();

Font getFont();

int getItemCount();

int getItemHeight();

TableTreeItem[] getItems();

TableTreeItem[] getSelection();

int getSelectionCount();

int getStyle();

Table getTable();

void createImages();

Image getPlusImage();

Image getMinusImage();

int indexOf(TableTreeItem item);

void onDispose(Event e);

void onResize(Event e);

void onSelection(Event e);

TableTreeItem getItem(int index);

TableTreeItem getItem(Point point);

TableTreeItem getItem(TableItem tableItem);

void onFocusIn(Event e);

void onKeyDown(Event e);

void onMouseDown(Event event);

void removeAll();

void removeItem(TableTreeItem item);

void removeSelectionListener(SelectionListener listener);

void removeTreeListener(TreeListener listener);

void selectAll();

void setBackground(Color color);

void setEnabled(bool enabled);

void setFont(Font font);

void setForeground(Color color);

void setMenu(Menu menu);

void setSelection(TableTreeItem[] items);

void setToolTipText(String string);

void showItem(TableTreeItem item);

void showSelection();

}

Constructors

this this(Composite parent, int style): Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. <p> The style value is either one of the style constants defined in class <code>SWT</code> which is applicable to instances of this class, or must be built by <em>bitwise OR</em>'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses. </p>

Members

Aliases

computeSize alias computeSize = Composite.computeSize: Undocumented in source.

Functions

addItem int addItem(TableTreeItem item, int index): Undocumented in source. Be warned that the author may not have intended to support it.
addSelectionListener void addSelectionListener(SelectionListener listener): Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the <code>SelectionListener</code> interface. <p> When <code>widgetSelected</code> is called, the item field of the event object is valid. If the receiver has <code>SWT.CHECK</code> style set and the check selection changes, the event object detail field contains the value <code>SWT.CHECK</code>. <code>widgetDefaultSelected</code> is typically called when an item is double-clicked. The item field of the event object is valid for default selection, but the detail field is not used. </p>
addTreeListener void addTreeListener(TreeListener listener): Adds the listener to the collection of listeners who will be notified when an item in the receiver is expanded or collapsed by sending it one of the messages defined in the <code>TreeListener</code> interface.
computeSize Point computeSize(int wHint, int hHint, bool changed): Undocumented in source. Be warned that the author may not have intended to support it.
computeTrim Rectangle computeTrim(int x, int y, int width, int height): Undocumented in source. Be warned that the author may not have intended to support it.
createImages void createImages(): Undocumented in source. Be warned that the author may not have intended to support it.
deselectAll void deselectAll(): Deselects all items. <p> If an item is selected, it is deselected. If an item is not selected, it remains unselected.
expandItem void expandItem(TableTreeItem item): Undocumented in source. Be warned that the author may not have intended to support it.
getBackground Color getBackground(): Undocumented in source. Be warned that the author may not have intended to support it.
getClientArea Rectangle getClientArea(): Undocumented in source. Be warned that the author may not have intended to support it.
getFont Font getFont(): Undocumented in source. Be warned that the author may not have intended to support it.
getForeground Color getForeground(): Undocumented in source. Be warned that the author may not have intended to support it.
getItem TableTreeItem getItem(int index): Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.
getItem TableTreeItem getItem(Point point): Returns the item at the given point in the receiver or null if no such item exists. The point is in the coordinate system of the receiver.
getItem TableTreeItem getItem(TableItem tableItem): Undocumented in source. Be warned that the author may not have intended to support it.
getItemCount int getItemCount(): Gets the number of items. <p> @return the number of items in the widget
getItemHeight int getItemHeight(): Gets the height of one item. <p> This operation will fail if the height of one item could not be queried from the OS.
getItems TableTreeItem[] getItems(): Gets the items. <p> @return the items in the widget
getMinusImage Image getMinusImage(): Undocumented in source. Be warned that the author may not have intended to support it.
getPlusImage Image getPlusImage(): Undocumented in source. Be warned that the author may not have intended to support it.
getSelection TableTreeItem[] getSelection(): Gets the selected items. <p> This operation will fail if the selected items cannot be queried from the OS.
getSelectionCount int getSelectionCount(): Gets the number of selected items. <p> This operation will fail if the number of selected items cannot be queried from the OS.
getStyle int getStyle(): Undocumented in source. Be warned that the author may not have intended to support it.
getTable Table getTable(): Returns the underlying Table control.
indexOf int indexOf(TableTreeItem item): Gets the index of an item.
onDispose void onDispose(Event e): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusIn void onFocusIn(Event e): Undocumented in source. Be warned that the author may not have intended to support it.
onKeyDown void onKeyDown(Event e): Undocumented in source. Be warned that the author may not have intended to support it.
onMouseDown void onMouseDown(Event event): Undocumented in source. Be warned that the author may not have intended to support it.
onResize void onResize(Event e): Undocumented in source. Be warned that the author may not have intended to support it.
onSelection void onSelection(Event e): Undocumented in source. Be warned that the author may not have intended to support it.
removeAll void removeAll(): Removes all items. <p> This operation will fail when an item could not be removed in the OS.
removeItem void removeItem(TableTreeItem item): Undocumented in source. Be warned that the author may not have intended to support it.
removeSelectionListener void removeSelectionListener(SelectionListener listener): Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.
removeTreeListener void removeTreeListener(TreeListener listener): Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.
selectAll void selectAll(): Selects all of the items in the receiver. <p> If the receiver is single-select, do nothing.
setBackground void setBackground(Color color): Undocumented in source. Be warned that the author may not have intended to support it.
setEnabled void setEnabled(bool enabled): Undocumented in source. Be warned that the author may not have intended to support it.
setFont void setFont(Font font): Undocumented in source. Be warned that the author may not have intended to support it.
setForeground void setForeground(Color color): Undocumented in source. Be warned that the author may not have intended to support it.
setMenu void setMenu(Menu menu): Undocumented in source. Be warned that the author may not have intended to support it.
setSelection void setSelection(TableTreeItem[] items): Sets the receiver's selection to be the given array of items. The current selection is cleared before the new items are selected. <p> Items that are not in the receiver are ignored. If the receiver is single-select and multiple items are specified, then all items are ignored.
setToolTipText void setToolTipText(String string): Undocumented in source. Be warned that the author may not have intended to support it.
showItem void showItem(TableTreeItem item): Shows the item. If the item is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled and expanded until the item is visible.
showSelection void showSelection(): Shows the selection. <p> If there is no selection or the selection is already visible, this method does nothing. If the selection is scrolled out of view, the top index of the widget is changed such that selection becomes visible.

Static variables

EMPTY_IMAGES Image[] EMPTY_IMAGES;: Undocumented in source.
EMPTY_ITEMS TableTreeItem[] EMPTY_ITEMS;: Undocumented in source.
EMPTY_TEXTS String[] EMPTY_TEXTS;: Undocumented in source.
ITEMID String ITEMID;: Undocumented in source.

Variables

inDispose bool inDispose;: Undocumented in source.
items TableTreeItem[] items;
minusImage Image minusImage;: Undocumented in source.
plusImage Image plusImage;
sizeImage Image sizeImage;: Undocumented in source.
table Table table;: Undocumented in source.

Inherited Members

From Composite

computeSize alias computeSize = Scrollable.computeSize: Undocumented in source.
fixStyle alias fixStyle = Scrollable.fixStyle: Undocumented in source.
forceFocus alias forceFocus = Scrollable.forceFocus: Undocumented in source.
gtk_button_press_event alias gtk_button_press_event = Scrollable.gtk_button_press_event: Undocumented in source.
moveAbove alias moveAbove = Scrollable.moveAbove: Undocumented in source.
moveBelow alias moveBelow = Scrollable.moveBelow: Undocumented in source.
setBounds alias setBounds = Scrollable.setBounds: Undocumented in source.
translateMnemonic alias translateMnemonic = Scrollable.translateMnemonic: Undocumented in source.
translateTraversal alias translateTraversal = Scrollable.translateTraversal: Undocumented in source.
embeddedHandle size_t embeddedHandle;: Undocumented in source.
imHandle_ GtkIMContext* imHandle_;: Undocumented in source.
socketHandle GtkWidget* socketHandle;: Undocumented in source.
layout_ Layout layout_;: Undocumented in source.
tabList Control[] tabList;: Undocumented in source.
layoutCount int layoutCount;
backgroundMode int backgroundMode;: Undocumented in source.
NO_INPUT_METHOD String NO_INPUT_METHOD;: Undocumented in source.
checkStyle int checkStyle(int style): Undocumented in source. Be warned that the author may not have intended to support it.
_getChildren Control[] _getChildren(): Undocumented in source. Be warned that the author may not have intended to support it.
_getTabList Control[] _getTabList(): Undocumented in source. Be warned that the author may not have intended to support it.
changed void changed(Control[] changed): Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver. If an ancestor does not have a layout, it is skipped.
checkBuffered void checkBuffered(): Undocumented in source. Be warned that the author may not have intended to support it.
checkSubclass void checkSubclass(): Undocumented in source. Be warned that the author may not have intended to support it.
childStyle GtkStyle* childStyle(): Undocumented in source. Be warned that the author may not have intended to support it.
computeSize Point computeSize(int wHint, int hHint, bool changed): Undocumented in source. Be warned that the author may not have intended to support it.
computeTabList Control[] computeTabList(): Undocumented in source. Be warned that the author may not have intended to support it.
createHandle void createHandle(int index): Undocumented in source. Be warned that the author may not have intended to support it.
createHandle void createHandle(int index, bool fixed, bool scrolled): Undocumented in source. Be warned that the author may not have intended to support it.
deregister void deregister(): Undocumented in source. Be warned that the author may not have intended to support it.
drawBackground void drawBackground(GC gc, int x, int y, int width, int height): Undocumented in source. Be warned that the author may not have intended to support it.
enableWidget void enableWidget(bool enabled): Undocumented in source. Be warned that the author may not have intended to support it.
findDeferredControl Composite findDeferredControl(): Undocumented in source. Be warned that the author may not have intended to support it.
findMenus Menu[] findMenus(Control control): Undocumented in source. Be warned that the author may not have intended to support it.
fixChildren void fixChildren(Shell newShell, Shell oldShell, Decorations newDecorations, Decorations oldDecorations, Menu[] menus): Undocumented in source. Be warned that the author may not have intended to support it.
fixModal void fixModal(GtkWidget* group, GtkWidget* modalGroup): Undocumented in source. Be warned that the author may not have intended to support it.
fixStyle void fixStyle(): Undocumented in source. Be warned that the author may not have intended to support it.
fixTabList void fixTabList(Control control): Undocumented in source. Be warned that the author may not have intended to support it.
fixZOrder void fixZOrder(): Undocumented in source. Be warned that the author may not have intended to support it.
focusHandle GtkWidget* focusHandle(): Undocumented in source. Be warned that the author may not have intended to support it.
forceFocus bool forceFocus(GtkWidget* focusHandle): Undocumented in source. Be warned that the author may not have intended to support it.
getBackgroundMode int getBackgroundMode(): Returns the receiver's background drawing mode. This will be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERTIT_FORCE</code>.
getChildren Control[] getChildren(): Returns a (possibly empty) array containing the receiver's children. Children are returned in the order that they are drawn. The topmost control appears at the beginning of the array. Subsequent controls draw beneath this control and appear later in the array. <p> Note: This is not the actual structure used by the receiver to maintain its list of children, so modifying the array will not affect the receiver. </p>
getChildrenCount int getChildrenCount(): Undocumented in source. Be warned that the author may not have intended to support it.
getClientArea Rectangle getClientArea(): Undocumented in source. Be warned that the author may not have intended to support it.
getClientWidth int getClientWidth(): Undocumented in source. Be warned that the author may not have intended to support it.
getLayout Layout getLayout(): Returns layout which is associated with the receiver, or null if one has not been set.
getLayoutDeferred bool getLayoutDeferred(): Returns <code>true</code> if the receiver has deferred the performing of layout, and <code>false</code> otherwise.
getTabList Control[] getTabList(): Gets the (possibly empty) tabbing order for the control.
gtk_button_press_event int gtk_button_press_event(GtkWidget* widget, GdkEventButton* event): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_expose_event int gtk_expose_event(GtkWidget* widget, GdkEventExpose* eventPtr): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_key_press_event int gtk_key_press_event(GtkWidget* widget, GdkEventKey* event): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_focus int gtk_focus(GtkWidget* widget, ptrdiff_t directionType): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_focus_in_event int gtk_focus_in_event(GtkWidget* widget, GdkEventFocus* event): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_focus_out_event int gtk_focus_out_event(GtkWidget* widget, GdkEventFocus* event): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_map int gtk_map(GtkWidget* widget): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_realize int gtk_realize(GtkWidget* widget): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_scroll_child int gtk_scroll_child(GtkWidget* widget, ptrdiff_t scrollType, ptrdiff_t horizontal): Undocumented in source. Be warned that the author may not have intended to support it.
gtk_style_set int gtk_style_set(GtkWidget* widget, ptrdiff_t previousStyle): Undocumented in source. Be warned that the author may not have intended to support it.
hasBorder bool hasBorder(): Undocumented in source. Be warned that the author may not have intended to support it.
hookEvents void hookEvents(): Undocumented in source. Be warned that the author may not have intended to support it.
hooksKeys bool hooksKeys(): Undocumented in source. Be warned that the author may not have intended to support it.
imHandle GtkIMContext* imHandle(): Undocumented in source. Be warned that the author may not have intended to support it.
isLayoutDeferred bool isLayoutDeferred(): Returns <code>true</code> if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts. Otherwise, <code>false</code> is returned.
isTabGroup bool isTabGroup(): Undocumented in source. Be warned that the author may not have intended to support it.
layout void layout(): If the receiver has a layout, asks the layout to <em>lay out</em> (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing. <p> This is equivalent to calling <code>layout(true)</code>. </p> <p> Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint. </p>
layout void layout(bool changed): If the receiver has a layout, asks the layout to <em>lay out</em> (that is, set the size and location of) the receiver's children. If the argument is <code>true</code> the layout must not rely on any information it has cached about the immediate children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing. <p> If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). </p> <p> Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint. </p>
layout void layout(bool changed, bool all): If the receiver has a layout, asks the layout to <em>lay out</em> (that is, set the size and location of) the receiver's children. If the changed argument is <code>true</code> the layout must not rely on any information it has cached about its children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the all argument is <code>true</code> the layout will cascade down through all child widgets in the receiver's widget tree, regardless of whether the child has changed size. The changed argument is applied to all layouts. If the all argument is <code>false</code>, the layout will <em>not</em> cascade down through all child widgets in the receiver's widget tree. However, if a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). </p> <p> Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint. </p>
layout void layout(Control[] changed): Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver. The layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it. <p> Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint. </p>
markLayout void markLayout(bool changed, bool all): Undocumented in source. Be warned that the author may not have intended to support it.
moveAbove void moveAbove(GtkWidget* child, GtkWidget* sibling): Undocumented in source. Be warned that the author may not have intended to support it.
moveBelow alias moveBelow = Scrollable.moveBelow: Undocumented in source.
moveBelow void moveBelow(GtkWidget* child, GtkWidget* sibling): Undocumented in source. Be warned that the author may not have intended to support it.
moveChildren void moveChildren(int oldWidth): Undocumented in source. Be warned that the author may not have intended to support it.
minimumSize Point minimumSize(int wHint, int hHint, bool changed): Undocumented in source. Be warned that the author may not have intended to support it.
parentingHandle GtkWidget* parentingHandle(): Undocumented in source. Be warned that the author may not have intended to support it.
printWidget void printWidget(GC gc, GdkDrawable* drawable, int depth, int x, int y): Undocumented in source. Be warned that the author may not have intended to support it.
redrawChildren void redrawChildren(): Undocumented in source. Be warned that the author may not have intended to support it.
register void register(): Undocumented in source. Be warned that the author may not have intended to support it.
releaseChildren void releaseChildren(bool destroy): Undocumented in source. Be warned that the author may not have intended to support it.
releaseHandle void releaseHandle(): Undocumented in source. Be warned that the author may not have intended to support it.
releaseWidget void releaseWidget(): Undocumented in source. Be warned that the author may not have intended to support it.
removeControl void removeControl(Control control): Undocumented in source. Be warned that the author may not have intended to support it.
resizeHandle void resizeHandle(int width, int height): Undocumented in source. Be warned that the author may not have intended to support it.
setBackgroundMode void setBackgroundMode(int mode): Sets the background drawing mode to the argument which should be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERIT_FORCE</code>.
setBounds int setBounds(int x, int y, int width, int height, bool move, bool resize): Undocumented in source. Be warned that the author may not have intended to support it.
setFocus bool setFocus(): Undocumented in source. Be warned that the author may not have intended to support it.
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null.
setLayoutDeferred void setLayoutDeferred(bool defer): If the argument is <code>true</code>, causes subsequent layout operations in the receiver or any of its children to be ignored. No layout of any kind can occur in the receiver or any of its children until the flag is set to false. Layout operations that occurred while the flag was <code>true</code> are remembered and when the flag is set to <code>false</code>, the layout operations are performed in an optimized manner. Nested calls to this method are stacked.
setScrollBarVisible bool setScrollBarVisible(ScrollBar bar, bool visible): Undocumented in source. Be warned that the author may not have intended to support it.
setTabGroupFocus bool setTabGroupFocus(bool next): Undocumented in source. Be warned that the author may not have intended to support it.
setTabItemFocus bool setTabItemFocus(bool next): Undocumented in source. Be warned that the author may not have intended to support it.
setTabList void setTabList(Control[] tabList): Sets the tabbing order for the specified controls to match the order that they occur in the argument list.
showWidget void showWidget(): Undocumented in source. Be warned that the author may not have intended to support it.
translateMnemonic bool translateMnemonic(Event event, Control control): Undocumented in source. Be warned that the author may not have intended to support it.
traversalCode int traversalCode(int key, GdkEventKey* event): Undocumented in source. Be warned that the author may not have intended to support it.
translateTraversal bool translateTraversal(GdkEventKey* keyEvent): Undocumented in source. Be warned that the author may not have intended to support it.
updateBackgroundMode void updateBackgroundMode(): Undocumented in source. Be warned that the author may not have intended to support it.
updateLayout void updateLayout(bool all): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

org eclipse swt custom TableTree modules