CCombo

The CCombo class represents a selectable user interface object that combines a text field and a list and issues notification when an item is selected from the list. CCombo was written to work around certain limitations in the native combo box. Specifically, on win32, the height of a CCombo can be set; attempts to set the height of a Combo are ignored. CCombo can be used anywhere that having the increased flexibility is more important than getting native L&F, but the decision should not be taken lightly. There is no is no strict requirement that CCombo look or behave the same as the native combo box. Note that although this class is a subclass of <code>Composite</code>, it does not make sense to add children to it, or set a layout on it. <dl> <dt>Styles: <dd>BORDER, READ_ONLY, FLAT</dd> <dt>Events: <dd>DefaultSelection, Modify, Selection, Verify</dd> </dl>

@see <a href="http://www.eclipse.org/swt/snippets/#ccombo">CCombo 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>

final

class CCombo : Composite {

Text text;

List list;

int visibleItemCount;

Shell popup;

Button arrow;

bool hasFocus;

Listener listener;

Listener filter;

Color foreground;

Color background;

Font font;

this(Composite parent, int style);

void add(String string);

void add(String string, int index);

void addModifyListener(ModifyListener listener);

void addSelectionListener(SelectionListener listener);

void addVerifyListener(VerifyListener listener);

void clearSelection();

void copy();

void cut();

void deselect(int index);

void deselectAll();

bool getEditable();

String getItem(int index);

int getItemCount();

int getItemHeight();

String[] getItems();

bool getListVisible();

Point getSelection();

int getSelectionIndex();

String getText();

int getTextHeight();

int getTextLimit();

int getVisibleItemCount();

int indexOf(String string);

int indexOf(String string, int start);

void paste();

void remove(int index);

void remove(int start, int end);

void remove(String string);

void removeAll();

void removeModifyListener(ModifyListener listener);

void removeSelectionListener(SelectionListener listener);

void removeVerifyListener(VerifyListener listener);

void select(int index);

void setEditable(bool editable);

void setItem(int index, String string);

void setItems(String[] items);

void setLayout(Layout layout);

void setListVisible(bool visible);

void setSelection(Point selection);

void setText(String string);

void setTextLimit(int limit);

void setVisibleItemCount(int count);

}

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

add void add(String string): Adds the argument to the end of the receiver's list.
add void add(String string, int index): Adds the argument to the receiver's list at the given zero-relative index. Note: To add an item at the end of the list, use the result of calling <code>getItemCount()</code> as the index or use <code>add(String)</code>.
addModifyListener void addModifyListener(ModifyListener listener): Adds the listener to the collection of listeners who will be notified when the receiver's text is modified, by sending it one of the messages defined in the <code>ModifyListener</code> interface.
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. <code>widgetSelected</code> is called when the combo's list selection changes. <code>widgetDefaultSelected</code> is typically called when ENTER is pressed the combo's text area.
addVerifyListener void addVerifyListener(VerifyListener listener): Adds the listener to the collection of listeners who will be notified when the receiver's text is verified, by sending it one of the messages defined in the <code>VerifyListener</code> interface.
clearSelection void clearSelection(): Sets the selection in the receiver's text field to an empty selection starting just before the first character. If the text field is editable, this has the effect of placing the i-beam at the start of the text. Note: To clear the selected items in the receiver's list, use <code>deselectAll()</code>.
copy void copy(): Copies the selected text. The current selection is copied to the clipboard.
cut void cut(): Cuts the selected text. The current selection is first copied to the clipboard and then deleted from the widget.
deselect void deselect(int index): Deselects the item at the given zero-relative index in the receiver's list. If the item at the index was already deselected, it remains deselected. Indices that are out of range are ignored.
deselectAll void deselectAll(): Deselects all selected items in the receiver's list. Note: To clear the selection in the receiver's text field, use <code>clearSelection()</code>.
getEditable bool getEditable(): Gets the editable state.
getItem String getItem(int index): Returns the item at the given, zero-relative index in the receiver's list. Throws an exception if the index is out of range.
getItemCount int getItemCount(): Returns the number of items contained in the receiver's list.
getItemHeight int getItemHeight(): Returns the height of the area which would be used to display one of the items in the receiver's list.
getItems String[] getItems(): Returns an array of <code>String</code>s which are the items in the receiver's list. Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.
getListVisible bool getListVisible(): Returns <code>true</code> if the receiver's list is visible, and <code>false</code> otherwise. If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.
getSelection Point getSelection(): Returns a <code>Point</code> whose x coordinate is the start of the selection in the receiver's text field, and whose y coordinate is the end of the selection. The returned values are zero-relative. An "empty" selection as indicated by the the x and y coordinates having the same value.
getSelectionIndex int getSelectionIndex(): Returns the zero-relative index of the item which is currently selected in the receiver's list, or -1 if no item is selected.
getText String getText(): Returns a string containing a copy of the contents of the receiver's text field.
getTextHeight int getTextHeight(): Returns the height of the receivers's text field.
getTextLimit int getTextLimit(): Returns the maximum number of characters that the receiver's text field is capable of holding. If this has not been changed by <code>setTextLimit()</code>, it will be the constant <code>Combo.LIMIT</code>.
getVisibleItemCount int getVisibleItemCount(): Gets the number of items that are visible in the drop down portion of the receiver's list.
indexOf int indexOf(String string): Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.
indexOf int indexOf(String string, int start): Searches the receiver's list starting at the given, zero-relative index until an item is found that is equal to the argument, and returns the index of that item. If no item is found or the starting index is out of range, returns -1.
paste void paste(): Pastes text from clipboard. The selected text is deleted from the widget and new text inserted from the clipboard.
remove void remove(int index): Removes the item from the receiver's list at the given zero-relative index.
remove void remove(int start, int end): Removes the items from the receiver's list which are between the given zero-relative start and end indices (inclusive).
remove void remove(String string): Searches the receiver's list starting at the first item until an item is found that is equal to the argument, and removes that item from the list.
removeAll void removeAll(): Removes all of the items from the receiver's list and clear the contents of receiver's text field. @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>
removeModifyListener void removeModifyListener(ModifyListener listener): Removes the listener from the collection of listeners who will be notified when the receiver's text is modified.
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.
removeVerifyListener void removeVerifyListener(VerifyListener listener): Removes the listener from the collection of listeners who will be notified when the control is verified.
select void select(int index): Selects the item at the given zero-relative index in the receiver's list. If the item at the index was already selected, it remains selected. Indices that are out of range are ignored.
setEditable void setEditable(bool editable): Sets the editable state.
setItem void setItem(int index, String string): Sets the text of the item in the receiver's list at the given zero-relative index to the string argument. This is equivalent to <code>remove</code>'ing the old item at the index, and then <code>add</code>'ing the new item at that index.
setItems void setItems(String[] items): Sets the receiver's list to be the given array of items.
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.
setListVisible void setListVisible(bool visible): Marks the receiver's list as visible if the argument is <code>true</code>, and marks it invisible otherwise. If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.
setSelection void setSelection(Point selection): Sets the selection in the receiver's text field to the range specified by the argument whose x coordinate is the start of the selection and whose y coordinate is the end of the selection.
setText void setText(String string): Sets the contents of the receiver's text field to the given string. Note: The text field in a <code>Combo</code> is typically only capable of displaying a single line of text. Thus, setting the text to a string containing line breaks or other special characters will probably cause it to display incorrectly.
setTextLimit void setTextLimit(int limit): Sets the maximum number of characters that the receiver's text field is capable of holding to be the argument.
setVisibleItemCount void setVisibleItemCount(int count): Sets the number of items that are visible in the drop down portion of the receiver's list.

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.