ViewForm

Instances of this class implement a Composite that positions and sizes children and allows programmatic control of layout and border parameters. ViewForm is used in the workbench to lay out a view's label/menu/toolbar local bar. <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>BORDER, FLAT</dd> <dt><b>Events:</b></dt> <dd>(None)</dd> </dl> <p> IMPORTANT: This class is <em>not</em> intended to be subclassed. </p>

@see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

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

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.
getClientArea
Rectangle getClientArea()
Undocumented in source. Be warned that the author may not have intended to support it.
getContent
Control getContent()

Returns the content area.

getTopCenter
Control getTopCenter()

Returns Control that appears in the top center of the pane. Typically this is a toolbar.

getTopLeft
Control getTopLeft()

Returns the Control that appears in the top left corner of the pane. Typically this is a label such as CLabel.

getTopRight
Control getTopRight()

Returns the control in the top right corner of the pane. Typically this is a Close button or a composite with a Menu and Close button.

onDispose
void onDispose()
Undocumented in source. Be warned that the author may not have intended to support it.
onPaint
void onPaint(GC gc)
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.
setBorderVisible
void setBorderVisible(bool show)

Specify whether the border should be displayed or not.

setContent
void setContent(Control content)

Sets the content. Setting the content to null will remove it from the pane - however, the creator of the content must dispose of the content.

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>

setSelectionBackground
void setSelectionBackground(Color color)
Undocumented in source. Be warned that the author may not have intended to support it.
setTopCenter
void setTopCenter(Control topCenter)

Set the control that appears in the top center of the pane. Typically this is a toolbar. The topCenter is optional. Setting the topCenter to null will remove it from the pane - however, the creator of the topCenter must dispose of the topCenter.

setTopCenterSeparate
void setTopCenterSeparate(bool show)

If true, the topCenter will always appear on a separate line by itself, otherwise the topCenter will appear in the top row if there is room and will be moved to the second row if required.

setTopLeft
void setTopLeft(Control c)

Set the control that appears in the top left corner of the pane. Typically this is a label such as CLabel. The topLeft is optional. Setting the top left control to null will remove it from the pane - however, the creator of the control must dispose of the control.

setTopRight
void setTopRight(Control c)

Set the control that appears in the top right corner of the pane. Typically this is a Close button or a composite with a Menu and Close button. The topRight is optional. Setting the top right control to null will remove it from the pane - however, the creator of the control must dispose of the control.

Static functions

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

Static variables

BORDER1_COLOR
int BORDER1_COLOR;
Undocumented in source.
OFFSCREEN
int OFFSCREEN;
Undocumented in source.
SELECTION_BACKGROUND
int SELECTION_BACKGROUND;
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

borderBottom
int borderBottom;
Undocumented in source.
borderLeft
int borderLeft;
Undocumented in source.
borderRight
int borderRight;
Undocumented in source.
borderTop
int borderTop;
Undocumented in source.
content
Control content;
Undocumented in source.
highlight
int highlight;
Undocumented in source.
horizontalSpacing
int horizontalSpacing;

horizontalSpacing specifies the number of pixels between the right edge of one cell and the left edge of its neighbouring cell to the right.

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.

oldSize
Point oldSize;
Undocumented in source.
selectionBackground
Color selectionBackground;
Undocumented in source.
separateTopCenter
bool separateTopCenter;
Undocumented in source.
separator
int separator;
Undocumented in source.
showBorder
bool showBorder;
Undocumented in source.
topCenter
Control topCenter;
Undocumented in source.
topLeft
Control topLeft;
Undocumented in source.
topRight
Control topRight;
Undocumented in source.
verticalSpacing
int verticalSpacing;

verticalSpacing specifies the number of pixels between the bottom edge of one cell and the top edge of its neighbouring cell underneath.

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