Composite

Instances of this class are controls which are capable of containing other controls. <dl> <dt><b>Styles:</b></dt> <dd>NO_BACKGROUND, NO_FOCUS, NO_MERGE_PAINTS, NO_REDRAW_RESIZE, NO_RADIO_GROUP, EMBEDDED, DOUBLE_BUFFERED</dd> <dt><b>Events:</b></dt> <dd>(none)</dd> </dl> <p> Note: The <code>NO_BACKGROUND</code>, <code>NO_FOCUS</code>, <code>NO_MERGE_PAINTS</code>, and <code>NO_REDRAW_RESIZE</code> styles are intended for use with <code>Canvas</code>. They can be used with <code>Composite</code> if you are drawing your own, but their behavior is undefined if they are used with subclasses of <code>Composite</code> other than <code>Canvas</code>. </p><p> Note: The <code>CENTER</code> style, although undefined for composites, has the same value as <code>EMBEDDED</code> (which is used to embed widgets from other widget toolkits into SWT). On some operating systems (GTK, Motif), this may cause the children of this composite to be obscured. The <code>EMBEDDED</code> style is for use by other widget toolkits and should normally never be used. </p><p> This class may be subclassed by custom control implementors who are building controls that are constructed from aggregates of other controls. </p>

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

class Composite : Scrollable {

alias computeSize = Scrollable.computeSize;

alias fixStyle = Scrollable.fixStyle;

alias forceFocus = Scrollable.forceFocus;

alias gtk_button_press_event = Scrollable.gtk_button_press_event;

alias moveAbove = Scrollable.moveAbove;

alias moveBelow = Scrollable.moveBelow;

alias setBounds = Scrollable.setBounds;

alias translateMnemonic = Scrollable.translateMnemonic;

alias translateTraversal = Scrollable.translateTraversal;

size_t embeddedHandle;

GtkIMContext* imHandle_;

GtkWidget* socketHandle;

Layout layout_;

Control[] tabList;

int layoutCount;

int backgroundMode;

String NO_INPUT_METHOD;

this(Composite parent, int style);

static int checkStyle(int style);

Control[] _getChildren();

Control[] _getTabList();

void changed(Control[] changed);

void checkBuffered();

void checkSubclass();

GtkStyle* childStyle();

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

Control[] computeTabList();

void createHandle(int index);

void createHandle(int index, bool fixed, bool scrolled);

void deregister();

void drawBackground(GC gc, int x, int y, int width, int height);

void enableWidget(bool enabled);

Composite findDeferredControl();

Menu[] findMenus(Control control);

void fixChildren(Shell newShell, Shell oldShell, Decorations newDecorations, Decorations oldDecorations, Menu[] menus);

void fixModal(GtkWidget* group, GtkWidget* modalGroup);

void fixStyle();

void fixTabList(Control control);

void fixZOrder();

GtkWidget* focusHandle();

bool forceFocus(GtkWidget* focusHandle);

int getBackgroundMode();

Control[] getChildren();

int getChildrenCount();

Rectangle getClientArea();

int getClientWidth();

Layout getLayout();

bool getLayoutDeferred();

Control[] getTabList();

int gtk_button_press_event(GtkWidget* widget, GdkEventButton* event);

int gtk_expose_event(GtkWidget* widget, GdkEventExpose* eventPtr);

int gtk_key_press_event(GtkWidget* widget, GdkEventKey* event);

int gtk_focus(GtkWidget* widget, ptrdiff_t directionType);

int gtk_focus_in_event(GtkWidget* widget, GdkEventFocus* event);

int gtk_focus_out_event(GtkWidget* widget, GdkEventFocus* event);

int gtk_map(GtkWidget* widget);

int gtk_realize(GtkWidget* widget);

int gtk_scroll_child(GtkWidget* widget, ptrdiff_t scrollType, ptrdiff_t horizontal);

int gtk_style_set(GtkWidget* widget, ptrdiff_t previousStyle);

bool hasBorder();

void hookEvents();

bool hooksKeys();

GtkIMContext* imHandle();

bool isLayoutDeferred();

bool isTabGroup();

void layout();

void layout(bool changed);

void layout(bool changed, bool all);

void layout(Control[] changed);

void markLayout(bool changed, bool all);

void moveAbove(GtkWidget* child, GtkWidget* sibling);

alias moveBelow = Scrollable.moveBelow;

void moveBelow(GtkWidget* child, GtkWidget* sibling);

void moveChildren(int oldWidth);

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

GtkWidget* parentingHandle();

void printWidget(GC gc, GdkDrawable* drawable, int depth, int x, int y);

void redrawChildren();

void register();

void releaseChildren(bool destroy);

void releaseHandle();

void releaseWidget();

void removeControl(Control control);

void resizeHandle(int width, int height);

void setBackgroundMode(int mode);

int setBounds(int x, int y, int width, int height, bool move, bool resize);

bool setFocus();

void setLayout(Layout layout);

void setLayoutDeferred(bool defer);

bool setScrollBarVisible(ScrollBar bar, bool visible);

bool setTabGroupFocus(bool next);

bool setTabItemFocus(bool next);

void setTabList(Control[] tabList);

void showWidget();

bool translateMnemonic(Event event, Control control);

int traversalCode(int key, GdkEventKey* event);

bool translateTraversal(GdkEventKey* keyEvent);

void updateBackgroundMode();

void updateLayout(bool all);

}

Constructors

this this(): Undocumented in source.
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 = 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.
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.

Functions

_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_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_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_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.
minimumSize Point minimumSize(int wHint, int hHint, bool changed): 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 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.
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.
translateTraversal bool translateTraversal(GdkEventKey* keyEvent): 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.
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.

Static functions

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

Static variables

NO_INPUT_METHOD String NO_INPUT_METHOD;
backgroundMode int backgroundMode;: Undocumented in source.

Variables

embeddedHandle size_t embeddedHandle;: Undocumented in source.
imHandle_ GtkIMContext* imHandle_;: Undocumented in source.
layoutCount int layoutCount;: Undocumented in source.
layout_ Layout layout_;: Undocumented in source.
socketHandle GtkWidget* socketHandle;: Undocumented in source.
tabList Control[] tabList;: Undocumented in source.

Inherited Members

From Scrollable

scrolledHandle GtkWidget* scrolledHandle;: Undocumented in source.
horizontalBar ScrollBar horizontalBar;
verticalBar ScrollBar verticalBar;: Undocumented in source.
clientHandle GtkWidget* clientHandle(): 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): Given a desired <em>client area</em> for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area. <p> In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent). </p>
createScrollBar ScrollBar createScrollBar(int style): Undocumented in source. Be warned that the author may not have intended to support it.
createWidget void createWidget(int index): 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.
destroyScrollBar void destroyScrollBar(ScrollBar bar): Undocumented in source. Be warned that the author may not have intended to support it.
getBorderWidth int getBorderWidth(): Undocumented in source. Be warned that the author may not have intended to support it.
getClientArea Rectangle getClientArea(): Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").
getHorizontalBar ScrollBar getHorizontalBar(): Returns the receiver's horizontal scroll bar if it has one, and null if it does not.
getVerticalBar ScrollBar getVerticalBar(): Returns the receiver's vertical scroll bar if it has one, and null if it does not.
gtk_scroll_event int gtk_scroll_event(GtkWidget* widget, GdkEventScroll* eventPtr): Undocumented in source. Be warned that the author may not have intended to support it.
hScrollBarWidth int hScrollBarWidth(): Undocumented in source. Be warned that the author may not have intended to support it.
sendLeaveNotify bool sendLeaveNotify(): Undocumented in source. Be warned that the author may not have intended to support it.
setOrientation void setOrientation(): Undocumented in source. Be warned that the author may not have intended to support it.
setScrollBarVisible bool setScrollBarVisible(ScrollBar bar, bool visible): Undocumented in source. Be warned that the author may not have intended to support it.
redrawBackgroundImage void redrawBackgroundImage(): Undocumented in source. Be warned that the author may not have intended to support it.
redrawWidget void redrawWidget(int x, int y, int width, int height, bool redrawAll, bool all, bool trim): 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.
releaseHandle void releaseHandle(): 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.
resizeHandle void resizeHandle(int width, int height): Undocumented in source. Be warned that the author may not have intended to support it.
showWidget void showWidget(): Undocumented in source. Be warned that the author may not have intended to support it.
topHandle GtkWidget* topHandle(): Undocumented in source. Be warned that the author may not have intended to support it.
updateScrollBarValue void updateScrollBarValue(ScrollBar bar): Undocumented in source. Be warned that the author may not have intended to support it.
vScrollBarWidth int vScrollBarWidth(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation