CTabFolder

Instances of this class implement the notebook user interface metaphor. It allows the user to select a notebook page from set of pages. <p> The item children that may be added to instances of this class must be of type <code>CTabItem</code>. <code>Control</code> children are created and then set into a tab item using <code>CTabItem#setControl</code>. </p><p> Note that although this class is a subclass of <code>Composite</code>, it does not make sense to set a layout on it. </p><p> <dl> <dt><b>Styles:</b></dt> <dd>CLOSE, TOP, BOTTOM, FLAT, BORDER, SINGLE, MULTI</dd> <dt><b>Events:</b></dt> <dd>Selection</dd> <dd>"CTabFolder2"</dd> </dl> <p> Note: Only one of the styles TOP and BOTTOM may be specified. </p><p> IMPORTANT: This class is <em>not</em> intended to be subclassed. </p>

@see <a href="http://www.eclipse.org/swt/snippets/#ctabfolder">CTabFolder, CTabItem snippets</a> @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: CustomControlExample</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class CTabFolder : Composite {}

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

Functions

_findMnemonic
dchar _findMnemonic(String string)
Undocumented in source. Be warned that the author may not have intended to support it.
_getToolTip
String _getToolTip(int x, int y)
Undocumented in source. Be warned that the author may not have intended to support it.
_setToolTipText
void _setToolTipText(int x, int y)
Undocumented in source. Be warned that the author may not have intended to support it.
addCTabFolder2Listener
void addCTabFolder2Listener(CTabFolder2Listener listener)

Adds the listener to the collection of listeners who will be notified when a tab item is closed, minimized, maximized, restored, or to show the list of items that are not currently visible.

addCTabFolderListener
void addCTabFolderListener(CTabFolderListener listener)

Adds the listener to the collection of listeners who will be notified when a tab item is closed.

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> <code>widgetSelected</code> is called when the user changes the selected tab. <code>widgetDefaultSelected</code> is not called. </p>

antialias
void antialias(int[] shape, RGB lineRGB, RGB innerRGB, RGB outerRGB, GC gc)
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.
createItem
void createItem(CTabItem item, int index)
Undocumented in source. Be warned that the author may not have intended to support it.
createSelectionHighlightGradientColors
void createSelectionHighlightGradientColors(Color start)
Undocumented in source. Be warned that the author may not have intended to support it.
destroyItem
void destroyItem(CTabItem item)
Undocumented in source. Be warned that the author may not have intended to support it.
disposeSelectionHighlightGradientColors
void disposeSelectionHighlightGradientColors()
Undocumented in source. Be warned that the author may not have intended to support it.
drawBackground
void drawBackground(GC gc, int[] shape, int x, int y, int width, int height, Color defaultBackground, Image image, Color[] colors, int[] percents, bool vertical)
Undocumented in source. Be warned that the author may not have intended to support it.
drawBackground
void drawBackground(GC gc, int[] shape, bool selected)
Undocumented in source. Be warned that the author may not have intended to support it.
drawBody
void drawBody(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
drawChevron
void drawChevron(GC gc)
Undocumented in source. Be warned that the author may not have intended to support it.
drawMaximize
void drawMaximize(GC gc)
Undocumented in source. Be warned that the author may not have intended to support it.
drawMinimize
void drawMinimize(GC gc)
Undocumented in source. Be warned that the author may not have intended to support it.
drawTabArea
void drawTabArea(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
getBorderVisible
bool getBorderVisible()

Returns <code>true</code> if the receiver's border is visible.

getClientArea
Rectangle getClientArea()
Undocumented in source. Be warned that the author may not have intended to support it.
getItem
CTabItem getItem(Point pt)

Gets the item at a point in the widget.

getItem
CTabItem getItem(int index)

Return the tab that is located at the specified index.

getItemCount
int getItemCount()

Return the number of tabs in the folder.

getItems
CTabItem[] getItems()

Return the tab items.

getMRUVisible
bool getMRUVisible()

Returns <code>true</code> if the receiver displays most recently used tabs and <code>false</code> otherwise. <p> When there is not enough horizontal space to show all the tabs, by default, tabs are shown sequentially from left to right in order of their index. When the MRU visibility is turned on, the tabs that are visible will be the tabs most recently selected. Tabs will still maintain their left to right order based on index but only the most recently selected tabs are visible. <p> For example, consider a CTabFolder that contains "Tab 1", "Tab 2", "Tab 3" and "Tab 4" (in order by index). The user selects "Tab 1" and then "Tab 3". If the CTabFolder is now compressed so that only two tabs are visible, by default, "Tab 2" and "Tab 3" will be shown ("Tab 3" since it is currently selected and "Tab 2" because it is the previous item in index order). If MRU visibility is enabled, the two visible tabs will be "Tab 1" and "Tab 3" (in that order from left to right).</p>

getMaximizeVisible
bool getMaximizeVisible()

Returns <code>true</code> if the maximize button is visible.

getMaximized
bool getMaximized()

Returns <code>true</code> if the receiver is maximized. <p>

getMinimizeVisible
bool getMinimizeVisible()

Returns <code>true</code> if the minimize button is visible.

getMinimized
bool getMinimized()

Returns <code>true</code> if the receiver is minimized.

getMinimumCharacters
int getMinimumCharacters()

Returns the number of characters that will appear in a fully compressed tab.

getRightItemEdge
int getRightItemEdge()
Undocumented in source. Be warned that the author may not have intended to support it.
getSelection
CTabItem getSelection()

Return the selected tab item, or null if there is no selection.

getSelectionBackground
Color getSelectionBackground()

Returns the receiver's selection background color.

getSelectionBackgroundGradientBegin
Color getSelectionBackgroundGradientBegin()
Undocumented in source. Be warned that the author may not have intended to support it.
getSelectionForeground
Color getSelectionForeground()

Returns the receiver's selection foreground color.

getSelectionIndex
int getSelectionIndex()

Return the index of the selected tab item, or -1 if there is no selection.

getSimple
bool getSimple()

Returns <code>true</code> if the CTabFolder is rendered with a simple, traditional shape.

getSingle
bool getSingle()

Returns <code>true</code> if the CTabFolder only displays the selected tab and <code>false</code> if the CTabFolder displays multiple tabs.

getStyle
int getStyle()
Undocumented in source. Be warned that the author may not have intended to support it.
getTabHeight
int getTabHeight()

Returns the height of the tab

getTabPosition
int getTabPosition()

Returns the position of the tab. Possible values are SWT.TOP or SWT.BOTTOM.

getTopRight
Control getTopRight()

Returns the control in the top right corner of the tab folder. Typically this is a close button or a composite with a menu and close button.

getUnselectedCloseVisible
bool getUnselectedCloseVisible()

Returns <code>true</code> if the close button appears when the user hovers over an unselected tabs.

getUnselectedImageVisible
bool getUnselectedImageVisible()

Returns <code>true</code> if an image appears in unselected tabs.

indexOf
int indexOf(CTabItem item)

Return the index of the specified tab or -1 if the tab is not in the receiver.

initAccessible
void initAccessible()
Undocumented in source. Be warned that the author may not have intended to support it.
isSelectionHighlightColorsCacheHit
bool isSelectionHighlightColorsCacheHit(Color start)
Undocumented in source. Be warned that the author may not have intended to support it.
onDispose
void onDispose(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onDragDetect
void onDragDetect(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onFocus
void onFocus(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onKeyDown
void onKeyDown(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onMnemonic
bool onMnemonic(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onMouse
void onMouse(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onMouseDoubleClick
void onMouseDoubleClick(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onPageTraversal
bool onPageTraversal(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onPaint
void onPaint(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
onResize
void onResize()
Undocumented in source. Be warned that the author may not have intended to support it.
onTraverse
void onTraverse(Event event)
Undocumented in source. Be warned that the author may not have intended to support it.
redrawTabs
void redrawTabs()
Undocumented in source. Be warned that the author may not have intended to support it.
removeCTabFolder2Listener
void removeCTabFolder2Listener(CTabFolder2Listener listener)

Removes the listener.

removeCTabFolderListener
void removeCTabFolderListener(CTabFolderListener listener)

Removes the listener.

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.

setBackground
void setBackground(Image image)

Set the image to be drawn in the background of the unselected tab. Image is stretched or compressed to cover entire unselected tab area.

setBackground
void setBackground(Color[] colors, int[] percents, bool vertical)

Specify a gradient of colours to be drawn in the background of the unselected tab. For example to draw a vertical gradient that varies from dark blue to blue and then to white, use the following call to setBackground: <pre> cfolder.setBackground(new Color[]{display.getSystemColor(SWT.COLOR_DARK_BLUE), display.getSystemColor(SWT.COLOR_BLUE), display.getSystemColor(SWT.COLOR_WHITE), display.getSystemColor(SWT.COLOR_WHITE)}, new int[] {25, 50, 100}, true); </pre>

setBackground
void setBackground(Color[] colors, int[] percents)

Specify a gradient of colours to be drawn in the background of the unselected tabs. For example to draw a gradient that varies from dark blue to blue and then to white, use the following call to setBackground: <pre> cfolder.setBackground(new Color[]{display.getSystemColor(SWT.COLOR_DARK_BLUE), display.getSystemColor(SWT.COLOR_BLUE), display.getSystemColor(SWT.COLOR_WHITE), display.getSystemColor(SWT.COLOR_WHITE)}, new int[] {25, 50, 100}); </pre>

setBackground
void setBackground(Color color)
Undocumented in source. Be warned that the author may not have intended to support it.
setBorderVisible
void setBorderVisible(bool show)

Toggle the visibility of the border

setButtonBounds
void setButtonBounds()
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.
setInsertMark
void setInsertMark(int index, bool after)

Display an insert marker before or after the specified tab item.

setInsertMark
void setInsertMark(CTabItem item, bool after)

Display an insert marker before or after the specified tab item.

setItemLocation
bool setItemLocation()
Undocumented in source. Be warned that the author may not have intended to support it.
setItemSize
bool setItemSize()
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. <p> Note: No Layout can be set on this Control because it already manages the size and position of its children. </p>

setMRUVisible
void setMRUVisible(bool show)

When there is not enough horizontal space to show all the tabs, by default, tabs are shown sequentially from left to right in order of their index. When the MRU visibility is turned on, the tabs that are visible will be the tabs most recently selected. Tabs will still maintain their left to right order based on index but only the most recently selected tabs are visible. <p> For example, consider a CTabFolder that contains "Tab 1", "Tab 2", "Tab 3" and "Tab 4" (in order by index). The user selects "Tab 1" and then "Tab 3". If the CTabFolder is now compressed so that only two tabs are visible, by default, "Tab 2" and "Tab 3" will be shown ("Tab 3" since it is currently selected and "Tab 2" because it is the previous item in index order). If MRU visibility is enabled, the two visible tabs will be "Tab 1" and "Tab 3" (in that order from left to right).</p>

setMaximizeVisible
void setMaximizeVisible(bool visible)

Marks the receiver's maximize button as visible if the argument is <code>true</code>, and marks it invisible otherwise.

setMaximized
void setMaximized(bool maximize)

Sets the maximized state of the receiver.

setMinimizeVisible
void setMinimizeVisible(bool visible)

Marks the receiver's minimize button as visible if the argument is <code>true</code>, and marks it invisible otherwise.

setMinimized
void setMinimized(bool minimize)

Sets the minimized state of the receiver.

setMinimumCharacters
void setMinimumCharacters(int count)

Sets the minimum number of characters that will be displayed in a fully compressed tab.

setSelection
void setSelection(int index, bool notify)
Undocumented in source. Be warned that the author may not have intended to support it.
setSelection
void setSelection(int index)

Set the selection to the tab at the specified index.

setSelection
void setSelection(CTabItem item)

Set the selection to the tab at the specified item.

setSelectionBackground
void setSelectionBackground(Image image)

Set the image to be drawn in the background of the selected tab. Image is stretched or compressed to cover entire selection tab area.

setSelectionBackground
void setSelectionBackground(Color[] colors, int[] percents, bool vertical)

Specify a gradient of colours to be draw in the background of the selected tab. For example to draw a vertical gradient that varies from dark blue to blue and then to white, use the following call to setBackground: <pre> cfolder.setBackground(new Color[]{display.getSystemColor(SWT.COLOR_DARK_BLUE), display.getSystemColor(SWT.COLOR_BLUE), display.getSystemColor(SWT.COLOR_WHITE), display.getSystemColor(SWT.COLOR_WHITE)}, new int[] {25, 50, 100}, true); </pre>

setSelectionBackground
void setSelectionBackground(Color[] colors, int[] percents)

Specify a gradient of colours to be draw in the background of the selected tab. For example to draw a gradient that varies from dark blue to blue and then to white, use the following call to setBackground: <pre> cfolder.setBackground(new Color[]{display.getSystemColor(SWT.COLOR_DARK_BLUE), display.getSystemColor(SWT.COLOR_BLUE), display.getSystemColor(SWT.COLOR_WHITE), display.getSystemColor(SWT.COLOR_WHITE)}, new int[] {25, 50, 100}); </pre>

setSelectionBackground
void setSelectionBackground(Color color)

Sets the receiver's selection background color to the color specified by the argument, or to the default system color for the control if the argument is null.

setSelectionForeground
void setSelectionForeground(Color color)

Set the foreground color of the selected tab.

setSelectionHighlightGradientColor
void setSelectionHighlightGradientColor(Color start)
Undocumented in source. Be warned that the author may not have intended to support it.
setSimple
void setSimple(bool simple)

Sets the shape that the CTabFolder will use to render itself.

setSingle
void setSingle(bool single)

Sets the number of tabs that the CTabFolder should display

setTabHeight
void setTabHeight(int height)

Specify a fixed height for the tab items. If no height is specified, the default height is the height of the text or the image, whichever is greater. Specifying a height of -1 will revert to the default height.

setTabPosition
void setTabPosition(int position)

Specify whether the tabs should appear along the top of the folder or along the bottom of the folder.

setTopRight
void setTopRight(Control control, int alignment)

Set the control that appears in the top right corner of the tab folder. Typically this is a close button or a composite with a Menu and close button. The topRight control is optional. Setting the top right control to null will remove it from the tab folder. <p> The alignment parameter sets the layout of the control in the tab area. <code>SWT.RIGHT</code> will cause the control to be positioned on the far right of the folder and it will have its default size. <code>SWT.FILL</code> will size the control to fill all the available space to the right of the last tab. If there is no available space, the control will not be visible. </p>

setTopRight
void setTopRight(Control control)

Set the control that appears in the top right corner of the tab folder. Typically this is a close button or a composite with a Menu and close button. The topRight control is optional. Setting the top right control to null will remove it from the tab folder.

setUnselectedCloseVisible
void setUnselectedCloseVisible(bool visible)

Specify whether the close button appears when the user hovers over an unselected tabs.

setUnselectedImageVisible
void setUnselectedImageVisible(bool visible)

Specify whether the image appears on unselected tabs.

showItem
void showItem(CTabItem item)

Shows the item. If the item is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled until the item is visible.

showList
void showList(Rectangle rect)
Undocumented in source. Be warned that the author may not have intended to support it.
showSelection
void showSelection()

Shows the selection. If the selection is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled until the selection is visible.

stripMnemonic
String stripMnemonic(String string)
Undocumented in source. Be warned that the author may not have intended to support it.
updateItems
bool updateItems(int showIndex)
Undocumented in source. Be warned that the author may not have intended to support it.
updateItems
bool updateItems()
Undocumented in source. Be warned that the author may not have intended to support it.
updateTabHeight
bool updateTabHeight(bool force)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

checkStyle
int checkStyle(Composite parent, int style)
Undocumented in source. Be warned that the author may not have intended to support it.
fillRegion
void fillRegion(GC gc, Region region)
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

BACKGROUND
int BACKGROUND;
Undocumented in source.
BORDER1_COLOR
int BORDER1_COLOR;
Undocumented in source.
BOTTOM_LEFT_CORNER
int[] BOTTOM_LEFT_CORNER;
Undocumented in source.
BOTTOM_LEFT_CORNER_BORDERLESS
int[] BOTTOM_LEFT_CORNER_BORDERLESS;
Undocumented in source.
BOTTOM_RIGHT_CORNER
int[] BOTTOM_RIGHT_CORNER;
Undocumented in source.
BOTTOM_RIGHT_CORNER_BORDERLESS
int[] BOTTOM_RIGHT_CORNER_BORDERLESS;
Undocumented in source.
BUTTON_BORDER
int BUTTON_BORDER;
Undocumented in source.
BUTTON_FILL
int BUTTON_FILL;
Undocumented in source.
BUTTON_SIZE
int BUTTON_SIZE;
Undocumented in source.
CHEVRON_CHILD_ID
int CHEVRON_CHILD_ID;
Undocumented in source.
CLOSE_FILL
RGB CLOSE_FILL;
Undocumented in source.
DEFAULT_HEIGHT
int DEFAULT_HEIGHT;
Undocumented in source.
DEFAULT_WIDTH
int DEFAULT_WIDTH;
Undocumented in source.
EXTRA_CHILD_ID_COUNT
int EXTRA_CHILD_ID_COUNT;
Undocumented in source.
FOREGROUND
int FOREGROUND;
Undocumented in source.
HOT
int HOT;
Undocumented in source.
MAXIMIZE_CHILD_ID
int MAXIMIZE_CHILD_ID;
Undocumented in source.
MINIMIZE_CHILD_ID
int MINIMIZE_CHILD_ID;
Undocumented in source.
NONE
int NONE;
Undocumented in source.
NORMAL
int NORMAL;
Undocumented in source.
SELECTED
int SELECTED;
Undocumented in source.
SELECTION_BACKGROUND
int SELECTION_BACKGROUND;
Undocumented in source.
SELECTION_FOREGROUND
int SELECTION_FOREGROUND;
Undocumented in source.
SIMPLE_BOTTOM_LEFT_CORNER
int[] SIMPLE_BOTTOM_LEFT_CORNER;
Undocumented in source.
SIMPLE_BOTTOM_LEFT_CORNER_BORDERLESS
int[] SIMPLE_BOTTOM_LEFT_CORNER_BORDERLESS;
Undocumented in source.
SIMPLE_BOTTOM_RIGHT_CORNER
int[] SIMPLE_BOTTOM_RIGHT_CORNER;
Undocumented in source.
SIMPLE_BOTTOM_RIGHT_CORNER_BORDERLESS
int[] SIMPLE_BOTTOM_RIGHT_CORNER_BORDERLESS;
Undocumented in source.
SIMPLE_TOP_LEFT_CORNER
int[] SIMPLE_TOP_LEFT_CORNER;
Undocumented in source.
SIMPLE_TOP_LEFT_CORNER_BORDERLESS
int[] SIMPLE_TOP_LEFT_CORNER_BORDERLESS;
Undocumented in source.
SIMPLE_TOP_RIGHT_CORNER
int[] SIMPLE_TOP_RIGHT_CORNER;
Undocumented in source.
SIMPLE_TOP_RIGHT_CORNER_BORDERLESS
int[] SIMPLE_TOP_RIGHT_CORNER_BORDERLESS;
Undocumented in source.
SIMPLE_UNSELECTED_INNER_CORNER
int[] SIMPLE_UNSELECTED_INNER_CORNER;
Undocumented in source.
TOP_LEFT_CORNER
int[] TOP_LEFT_CORNER;
Undocumented in source.
TOP_LEFT_CORNER_BORDERLESS
int[] TOP_LEFT_CORNER_BORDERLESS;
Undocumented in source.
TOP_LEFT_CORNER_HILITE
int[] TOP_LEFT_CORNER_HILITE;
Undocumented in source.
TOP_RIGHT_CORNER
int[] TOP_RIGHT_CORNER;
Undocumented in source.
TOP_RIGHT_CORNER_BORDERLESS
int[] TOP_RIGHT_CORNER_BORDERLESS;
Undocumented in source.
borderColor
Color borderColor;
Undocumented in source.
borderInsideRGB
RGB borderInsideRGB;

Color of innermost line of drop shadow border.

borderMiddleRGB
RGB borderMiddleRGB;

Color of middle line of drop shadow border.

borderOutsideRGB
RGB borderOutsideRGB;

Color of outermost line of drop shadow border.

Variables

MIN_TAB_WIDTH
int MIN_TAB_WIDTH;

A multiple of the tab height that specifies the minimum width to which a tab will be compressed before scrolling arrows are used to navigate the tabs.

bgImage
Image bgImage;
Undocumented in source.
borderBottom
int borderBottom;
Undocumented in source.
borderLeft
int borderLeft;
Undocumented in source.
borderRight
int borderRight;
Undocumented in source.
borderTop
int borderTop;
Undocumented in source.
chevronImageState
int chevronImageState;
Undocumented in source.
chevronRect
Rectangle chevronRect;
Undocumented in source.
curve
int[] curve;
Undocumented in source.
curveIndent
int curveIndent;
Undocumented in source.
curveWidth
int curveWidth;
Undocumented in source.
firstIndex
int firstIndex;
Undocumented in source.
fixedTabHeight
int fixedTabHeight;
Undocumented in source.
folderListeners
CTabFolder2Listener[] folderListeners;
Undocumented in source.
gradientColors
Color[] gradientColors;
Undocumented in source.
gradientPercents
int[] gradientPercents;
Undocumented in source.
gradientVertical
bool gradientVertical;
Undocumented in source.
highlight_header
int highlight_header;
Undocumented in source.
highlight_margin
int highlight_margin;
Undocumented in source.
inDispose
bool inDispose;
Undocumented in source.
items
CTabItem[] items;
Undocumented in source.
listener
Listener listener;
Undocumented in source.
marginHeight
int marginHeight;

marginHeight specifies the number of pixels of vertical margin that will be placed along the top and bottom edges of the form.

marginWidth
int marginWidth;

marginWidth specifies the number of pixels of horizontal margin that will be placed along the left and right edges of the form.

maxImageState
int maxImageState;
Undocumented in source.
maxRect
Rectangle maxRect;
Undocumented in source.
maximized
bool maximized;
Undocumented in source.
minChars
int minChars;
Undocumented in source.
minImageState
int minImageState;
Undocumented in source.
minRect
Rectangle minRect;
Undocumented in source.
minimized
bool minimized;
Undocumented in source.
mru
bool mru;
Undocumented in source.
oldFont
Font oldFont;
Undocumented in source.
oldSize
Point oldSize;
Undocumented in source.
onBottom
bool onBottom;
Undocumented in source.
priority
int[] priority;
Undocumented in source.
selectedIndex
int selectedIndex;
Undocumented in source.
selectionBackground
Color selectionBackground;
Undocumented in source.
selectionBgImage
Image selectionBgImage;
Undocumented in source.
selectionFadeStart
Color selectionFadeStart;
Undocumented in source.
selectionForeground
Color selectionForeground;
Undocumented in source.
selectionGradientColors
Color[] selectionGradientColors;
Undocumented in source.
selectionGradientPercents
int[] selectionGradientPercents;
Undocumented in source.
selectionGradientVertical
bool selectionGradientVertical;
Undocumented in source.
selectionHighlightGradientBegin
Color selectionHighlightGradientBegin;
Undocumented in source.
selectionHighlightGradientColorsCache
Color[] selectionHighlightGradientColorsCache;
Undocumented in source.
showChevron
bool showChevron;
Undocumented in source.
showClose
bool showClose;
Undocumented in source.
showMax
bool showMax;
Undocumented in source.
showMenu
Menu showMenu;
Undocumented in source.
showMin
bool showMin;
Undocumented in source.
showUnselectedClose
bool showUnselectedClose;
Undocumented in source.
showUnselectedImage
bool showUnselectedImage;
Undocumented in source.
simple
bool simple;
Undocumented in source.
single
bool single;
Undocumented in source.
tabHeight
int tabHeight;
Undocumented in source.
tabListeners
CTabFolderListener[] tabListeners;
Undocumented in source.
topCurveHighlightEnd
int[] topCurveHighlightEnd;
Undocumented in source.
topCurveHighlightStart
int[] topCurveHighlightStart;
Undocumented in source.
topRight
Control topRight;
Undocumented in source.
topRightAlignment
int topRightAlignment;
Undocumented in source.
topRightRect
Rectangle topRightRect;
Undocumented in source.
xClient
int xClient;
yClient
int yClient;
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