CBanner

Instances of this class implement a Composite that lays out its children and allows programmatic control of the layout. It draws a separator between the left and right children which can be dragged to resize the right control. CBanner is used in the workbench to layout the toolbar area and perspective switching toolbar. Note that although this class is a subclass of <code>Composite</code>, it does not make sense to set a layout on it. <dl> <dt>Styles:</dt> <dd>NONE</dd> <dt>Events:</dt> <dd>(None)</dd> </dl> IMPORTANT: This class is not intended to be subclassed.

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

@since 3.0

class CBanner : Composite {

Control left;

Control right;

Control bottom;

bool simple;

int[] curve;

int curveStart;

Rectangle curveRect;

int curve_width;

int curve_indent;

int rightWidth;

int rightMinWidth;

int rightMinHeight;

Cursor resizeCursor;

bool dragging;

int rightDragDisplacement;

int OFFSCREEN;

int BORDER_BOTTOM;

int BORDER_TOP;

int BORDER_STRIPE;

int CURVE_TAIL;

int BEZIER_RIGHT;

int BEZIER_LEFT;

int MIN_LEFT;

int BORDER1;

this(Composite parent, int style);

Control getBottom();

Control getLeft();

Control getRight();

Point getRightMinimumSize();

int getRightWidth();

bool getSimple();

void setBottom(Control control);

void setLayout(Layout layout);

void setLeft(Control control);

void setRight(Control control);

void setRightMinimumSize(Point size);

void setRightWidth(int width);

void setSimple(bool simple);

}

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. 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 bitwise OR'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.

Members

Functions

getBottom Control getBottom(): Returns the Control that appears on the bottom side of the banner. * @return the control that appears on the bottom side of the banner or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul> * @since 3.0
getLeft Control getLeft(): Returns the Control that appears on the left side of the banner. * @return the control that appears on the left side of the banner or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul> * @since 3.0
getRight Control getRight(): Returns the Control that appears on the right side of the banner. * @return the control that appears on the right side of the banner or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul> * @since 3.0
getRightMinimumSize Point getRightMinimumSize(): Returns the minimum size of the control that appears on the right of the banner.
getRightWidth int getRightWidth(): Returns the width of the control that appears on the right of the banner.
getSimple bool getSimple(): Returns <code>true</code> if the CBanner is rendered with a simple, traditional shape.
setBottom void setBottom(Control control): Set the control that appears on the bottom side of the banner. The bottom control is optional. Setting the bottom control to null will remove it from the banner - however, the creator of the control must dispose of the control. * @param control the control to be displayed on the bottom or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the bottom control was not created as a child of the receiver</li> </ul> * @since 3.0
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null. Note: No Layout can be set on this Control because it already manages the size and position of its children.
setLeft void setLeft(Control control): Set the control that appears on the left side of the banner. The left control is optional. Setting the left control to null will remove it from the banner - however, the creator of the control must dispose of the control. * @param control the control to be displayed on the left or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the left control was not created as a child of the receiver</li> </ul> * @since 3.0
setRight void setRight(Control control): Set the control that appears on the right side of the banner. The right control is optional. Setting the right control to null will remove it from the banner - however, the creator of the control must dispose of the control. * @param control the control to be displayed on the right or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the right control was not created as a child of the receiver</li> </ul> * @since 3.0
setRightMinimumSize void setRightMinimumSize(Point size): Set the minimum height of the control that appears on the right side of the banner.
setRightWidth void setRightWidth(int width): Set the width of the control that appears on the right side of the banner.
setSimple void setSimple(bool simple): Sets the shape that the CBanner will use to render itself.

Inherited Members

From Composite

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.
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. 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.
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.
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.
layout void layout(): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing. This is equivalent to calling <code>layout(true)</code>. 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.
layout void layout(bool changed): If the receiver has a layout, asks the layout to lay out (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. 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>). 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.
layout void layout(bool changed, bool all): If the receiver has a layout, asks the layout to lay out (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 not 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>). 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.
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. 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.
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>.
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.
setTabList void setTabList(Control[] tabList): Sets the tabbing order for the specified controls to match the order that they occur in the argument list.