Caret

Instances of this class provide an i-beam that is typically used as the insertion point for text. <dl> <dt>Styles:</dt> <dd>(none)</dd> <dt>Events:</dt> <dd>(none)</dd> </dl> IMPORTANT: This class is intended to be subclassed only within the SWT implementation.

@see <a href="http://www.eclipse.org/swt/snippets/#caret">Caret snippets</a> @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Canvas tab</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class Caret : Widget {

Canvas parent;

int x;

int y;

int width;

int height;

bool isVisible_;

bool isShowing;

int blinkRate;

Image image;

Font font;

int DEFAULT_WIDTH;

this(Canvas parent, int style);

Rectangle getBounds();

Font getFont();

Image getImage();

Point getLocation();

Canvas getParent();

Point getSize();

bool getVisible();

bool isVisible();

void setBounds(int x, int y, int width, int height);

void setBounds(Rectangle rect);

void setFont(Font font);

void setImage(Image image);

void setLocation(int x, int y);

void setLocation(Point location);

void setSize(int width, int height);

void setSize(Point size);

void setVisible(bool visible);

}

Constructors

this this(Canvas 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

getBounds Rectangle getBounds(): Returns a rectangle describing the receiver's size and location relative to its parent (or its display if its parent is null).
getFont Font getFont(): Returns the font that the receiver will use to paint textual information.
getImage Image getImage(): Returns the image that the receiver will use to paint the caret.
getLocation Point getLocation(): Returns a point describing the receiver's location relative to its parent (or its display if its parent is null).
getParent Canvas getParent(): Returns the receiver's parent, which must be a <code>Canvas</code>.
getSize Point getSize(): Returns a point describing the receiver's size.
getVisible bool getVisible(): Returns <code>true</code> if the receiver 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.
isVisible bool isVisible(): Returns <code>true</code> if the receiver is visible and all of the receiver's ancestors are visible and <code>false</code> otherwise.
setBounds void setBounds(int x, int y, int width, int height): Sets the receiver's size and location to the rectangular area specified by the arguments. The <code>x</code> and <code>y</code> arguments are relative to the receiver's parent (or its display if its parent is null).
setBounds void setBounds(Rectangle rect): Sets the receiver's size and location to the rectangular area specified by the argument. The <code>x</code> and <code>y</code> fields of the rectangle are relative to the receiver's parent (or its display if its parent is null).
setFont void setFont(Font font): Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.
setImage void setImage(Image image): Sets the image that the receiver will use to paint the caret to the image specified by the argument, or to the default which is a filled rectangle if the argument is null
setLocation void setLocation(int x, int y): Sets the receiver's location to the point specified by the arguments which are relative to the receiver's parent (or its display if its parent is null).
setLocation void setLocation(Point location): Sets the receiver's location to the point specified by the argument which is relative to the receiver's parent (or its display if its parent is null).
setSize void setSize(int width, int height): Sets the receiver's size to the point specified by the arguments.
setSize void setSize(Point size): Sets the receiver's size to the point specified by the argument.
setVisible void setVisible(bool visible): Marks the receiver 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.

Inherited Members

handle GtkWidget* handle;: the handle to the OS resource (Warning: This field is platform dependent) IMPORTANT: This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.
addListener void addListener(int eventType, Listener listener): Adds the listener to the collection of listeners who will be notified when an event of the given type occurs. When the event does occur in the widget, the listener is notified by sending it the <code>handleEvent()</code> message. The event type is one of the event constants defined in class <code>SWT</code>.
addDisposeListener void addDisposeListener(DisposeListener listener): Adds the listener to the collection of listeners who will be notified when the widget is disposed. When the widget is disposed, the listener is notified by sending it the <code>widgetDisposed()</code> message.
checkParent void checkParent(Widget parent): Throws an exception if the specified widget can not be used as a parent for the receiver.
checkSubclass void checkSubclass(): Checks that this class can be subclassed. The SWT class library is intended to be subclassed only at specific, controlled points (most notably, <code>Composite</code> and <code>Canvas</code> when implementing new widgets). This method enforces this rule unless it is overridden. IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion. The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.
checkWidget void checkWidget(): Throws an <code>SWTException</code> if the receiver can not be accessed by the caller. This may include both checks on the state of the receiver and more generally on the entire execution context. This method should be called by widget implementors to enforce the standard SWT invariants. Currently, it is an error to invoke any method (other than <code>isDisposed()</code>) on a widget that has had its <code>dispose()</code> method called. It is also an error to call widget methods from any thread that is different from the thread that created the widget. In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.
dispose void dispose(): Disposes of the operating system resources associated with the receiver and all its descendants. After this method has been invoked, the receiver and all descendants will answer <code>true</code> when sent the message <code>isDisposed()</code>. Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection. NOTE: This method is not called recursively on the descendants of the receiver. This means that, widget implementers can not detect when a widget is being disposed of by re-implementing this method, but should instead listen for the <code>Dispose</code> event.
getData Object getData(): Returns the application defined widget data associated with the receiver, or null if it has not been set. The widget data is a single, unnamed field that is stored with every widget. Applications may put arbitrary objects in this field. If the object stored in the widget data needs to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.
getData Object getData(String key): Returns the application defined property of the receiver with the specified name, or null if it has not been set. Applications may have associated arbitrary objects with the receiver in this fashion. If the objects stored in the properties need to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.
getDisplay Display getDisplay(): Returns the <code>Display</code> that is associated with the receiver. A widget's display is either provided when it is created (for example, top level <code>Shell</code>s) or is the same as its parent's display.
getListeners Listener[] getListeners(int eventType): Returns an array of listeners who will be notified when an event of the given type occurs. The event type is one of the event constants defined in class <code>SWT</code>.
getStyle int getStyle(): Returns the receiver's style information. Note that the value which is returned by this method may not match the value which was provided to the constructor when the receiver was created. This can occur when the underlying operating system does not support a particular combination of requested styles. For example, if the platform widget used to implement a particular SWT widget always has scroll bars, the result of calling this method would always have the <code>SWT.H_SCROLL</code> and <code>SWT.V_SCROLL</code> bits set.
isDisposed bool isDisposed(): Returns <code>true</code> if the widget has been disposed, and <code>false</code> otherwise. This method gets the dispose state for the widget. When a widget has been disposed, it is an error to invoke any other method using the widget.
isListening bool isListening(int eventType): Returns <code>true</code> if there are any listeners for the specified event type associated with the receiver, and <code>false</code> otherwise. The event type is one of the event constants defined in class <code>SWT</code>.
notifyListeners void notifyListeners(int eventType, Event event): Notifies all of the receiver's listeners for events of the given type that one such event has occurred by invoking their <code>handleEvent()</code> method. The event type is one of the event constants defined in class <code>SWT</code>.
removeListener void removeListener(int eventType, Listener handler): Removes the listener from the collection of listeners who will be notified when an event of the given type occurs. The event type is one of the event constants defined in class <code>SWT</code>.
removeListener void removeListener(int eventType, SWTEventListener handler): Removes the listener from the collection of listeners who will be notified when an event of the given type occurs. IMPORTANT: This method is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It should never be referenced from application code.
removeDisposeListener void removeDisposeListener(DisposeListener listener): Removes the listener from the collection of listeners who will be notified when the widget is disposed.
setData void setData(Object data): Sets the application defined widget data associated with the receiver to be the argument. The widget data is a single, unnamed field that is stored with every widget. Applications may put arbitrary objects in this field. If the object stored in the widget data needs to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.
setData void setData(String key, Object value): Sets the application defined property of the receiver with the specified name to the given value. Applications may associate arbitrary objects with the receiver in this fashion. If the objects stored in the properties need to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.
toString String toString(): Returns a string containing a concise, human-readable description of the receiver.

Caret

Constructors

Members

Functions

Inherited Members

From Widget

Meta

Source