Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.widgets.Canvas

Modifier and Type	Field and Description
pack-priv boolean	blink
pack-priv Caret	caret
pack-priv boolean	drawFlag
pack-priv IME	ime

Access	Constructor and Description
pack-priv	Canvas()
public	Canvas(Composite a composite control which will be the parent of the new instance (cannot be null) parent, int the style of control to construct style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and Type	Method and Description
public void	drawBackground(GC the gc where the rectangle is to be filled gc, int the x coordinate of the rectangle to be filled x, int the y coordinate of the rectangle to be filled y, int the width of the rectangle to be filled width, int the height of the rectangle to be filled height) Fills the interior of the rectangle specified by the arguments, with the receiver's background.
private void	drawCaret(long widget, long cairo)
pack-priv void	drawCaretInFocus(long widget, long cairo)
public Caret	Returns: the caret for the receiver, may be null getCaret() Returns the caret.
pack-priv Point	getIMCaretPos() Overrides org.eclipse.swt.widgets.Control.getIMCaretPos.
public IME	Returns: the IME getIME() Returns the IME.
pack-priv long	gtk_button_press_event(long widget, long event) Overrides org.eclipse.swt.widgets.Composite.gtk_button_press_event.
pack-priv long	gtk_commit(long imcontext, long text) Overrides org.eclipse.swt.widgets.Control.gtk_commit.
pack-priv long	gtk_draw(long widget, long cairo) Overrides org.eclipse.swt.widgets.Composite.gtk_draw.
pack-priv long	gtk_focus_in_event(long widget, long event) Overrides org.eclipse.swt.widgets.Composite.gtk_focus_in_event.
pack-priv long	gtk_focus_out_event(long widget, long event) Overrides org.eclipse.swt.widgets.Composite.gtk_focus_out_event.
pack-priv long	gtk_preedit_changed(long imcontext) Overrides org.eclipse.swt.widgets.Control.gtk_preedit_changed.
pack-priv void	redrawWidget(int x, int y, int width, int height, boolean redrawAll, boolean all, boolean trim) Overrides org.eclipse.swt.widgets.Scrollable.redrawWidget.
pack-priv void	releaseChildren(boolean destroy) Overrides org.eclipse.swt.widgets.Composite.releaseChildren.
pack-priv void	reskinChildren(int flags) Overrides org.eclipse.swt.widgets.Composite.reskinChildren.
public void	scroll(int the x coordinate of the destination destX, int the y coordinate of the destination destY, int the x coordinate of the source x, int the y coordinate of the source y, int the width of the area width, int the height of the area height, boolean `true`if children should be scrolled, and `false` otherwise all) Scrolls a rectangular area of the receiver by first copying the source area to the destination and then causing the area of the source which is not covered by the destination to be repainted.
pack-priv void	scrollInPixels(int destX, int destY, int x, int y, int width, int height, boolean all)
pack-priv int	setBounds(int x, int y, int width, int height, boolean move, boolean resize) Overrides org.eclipse.swt.widgets.Composite.setBounds.
public void	setCaret(Caret the new caret for the receiver, may be null caret) Sets the receiver's caret.
public void	setFont(Font the new font (or null) font) Overrides org.eclipse.swt.widgets.Control.setFont. 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.
public void	setIME(IME the new IME for the receiver, may be null ime) Sets the receiver's IME.
pack-priv void	updateCaret()

Inherited from org.eclipse.swt.widgets.Composite:: _getChildren _getTabList adjustChildClipping applyThemeBackground changed checkBuffered checkStyle checkSubclass checkSubwindow computeSizeInPixels computeTabList connectFixedHandleDraw createHandle createHandle deregister drawBackground drawBackgroundInPixels enableWidget findDeferredControl findMenus fixChildren fixClippings fixModal fixParentGdkResource fixStyle fixTabList fixZOrder focusHandle forceFocus getBackgroundMode getChildren getChildrenCount getClientAreaInPixels getLayout getLayoutDeferred getTabList gtk4_key_press_event gtk_focus gtk_key_press_event gtk_map gtk_realize gtk_scroll_child gtk_style_updated hasBorder hookEvents hooksKeys imHandle isLayoutDeferred isTabGroup layout layout layout layout layout markLayout minimumSize moveAbove moveBelow moveChildren mustBeVisibleOnInitBounds parentingHandle printWidget propagateDraw redrawChildren register releaseHandle releaseWidget removeControl resizeHandle setBackgroundMode setFocus setLayout setLayoutDeferred setOrientation setScrollBarVisible setTabGroupFocus setTabItemFocus setTabList showWidget toString translateMnemonic translateTraversal traversalCode updateBackgroundMode updateLayout

blink	back to summary
pack-priv boolean blink

caret	back to summary
pack-priv Caret caret

drawFlag	back to summary
pack-priv boolean drawFlag

ime	back to summary
pack-priv IME ime

Canvas	back to summary
pack-priv Canvas()

Canvas	back to summary
public Canvas(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 `SWT` which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the `int` "\|" operator) two or more of those `SWT` style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses. Parameters parent:Composite a composite control which will be the parent of the new instance (cannot be null) style:int the style of control to construct Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the parent is null SWTException: ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent See Also `SWT`, `Widget#getStyle`

Method Detail

drawBackground	back to summary
public void drawBackground(GC gc, int x, int y, int width, int height) Fills the interior of the rectangle specified by the arguments, with the receiver's background. Parameters gc:GC the gc where the rectangle is to be filled x:int the x coordinate of the rectangle to be filled y:int the y coordinate of the rectangle to be filled width:int the width of the rectangle to be filled height:int the height of the rectangle to be filled Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the gc is null ERROR_INVALID_ARGUMENT - if the gc has been disposed SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.2

drawBackground

back to summary

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

Fills the interior of the rectangle specified by the arguments, with the receiver's background.

Parameters

gc:GC: the gc where the rectangle is to be filled
x:int: the x coordinate of the rectangle to be filled
y:int: the y coordinate of the rectangle to be filled
width:int: the width of the rectangle to be filled
height:int: the height of the rectangle to be filled

Exceptions

IllegalArgumentException:

ERROR_NULL_ARGUMENT - if the gc is null
ERROR_INVALID_ARGUMENT - if the gc has been disposed

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since

3.2

drawCaret	back to summary
private void drawCaret(long widget, long cairo)

drawCaretInFocus	back to summary
pack-priv void drawCaretInFocus(long widget, long cairo)

getCaret	back to summary
public Caret getCaret() Returns the caret. The caret for the control is automatically hidden and shown when the control is painted or resized, when focus is gained or lost and when an the control is scrolled. To avoid drawing on top of the caret, the programmer must hide and show the caret when drawing in the window any other time. Returns:Caret the caret for the receiver, may be null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getCaret

back to summary

public Caret getCaret()

Returns the caret.

The caret for the control is automatically hidden and shown when the control is painted or resized, when focus is gained or lost and when an the control is scrolled. To avoid drawing on top of the caret, the programmer must hide and show the caret when drawing in the window any other time.

Returns:Caret

the caret for the receiver, may be null

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getIMCaretPos	back to summary
pack-priv Point getIMCaretPos() Overrides org.eclipse.swt.widgets.Control.getIMCaretPos. Annotations @Override

getIMCaretPos

back to summary

pack-priv Point getIMCaretPos()

Overrides org.eclipse.swt.widgets.Control.getIMCaretPos.

Annotations

@Override

getIME	back to summary
public IME getIME() Returns the IME. Returns:IME the IME Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.4

getIME

back to summary

public IME getIME()

Returns the IME.

Returns:IME

the IME

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since

3.4

gtk_button_press_event	back to summary
pack-priv long gtk_button_press_event(long widget, long event) Overrides org.eclipse.swt.widgets.Composite.gtk_button_press_event. Annotations @Override

gtk_button_press_event

back to summary

pack-priv long gtk_button_press_event(long widget, long event)

Overrides org.eclipse.swt.widgets.Composite.gtk_button_press_event.

Annotations

@Override

gtk_commit	back to summary
pack-priv long gtk_commit(long imcontext, long text) Overrides org.eclipse.swt.widgets.Control.gtk_commit. Annotations @Override

gtk_commit

back to summary

pack-priv long gtk_commit(long imcontext, long text)

Overrides org.eclipse.swt.widgets.Control.gtk_commit.

Annotations

@Override

gtk_draw	back to summary
pack-priv long gtk_draw(long widget, long cairo) Overrides org.eclipse.swt.widgets.Composite.gtk_draw. Annotations @Override

gtk_draw

back to summary

pack-priv long gtk_draw(long widget, long cairo)

Overrides org.eclipse.swt.widgets.Composite.gtk_draw.

Annotations

@Override

gtk_focus_in_event	back to summary
pack-priv long gtk_focus_in_event(long widget, long event) Overrides org.eclipse.swt.widgets.Composite.gtk_focus_in_event. Annotations @Override

gtk_focus_in_event

back to summary

pack-priv long gtk_focus_in_event(long widget, long event)

Overrides org.eclipse.swt.widgets.Composite.gtk_focus_in_event.

Annotations

@Override

gtk_focus_out_event	back to summary
pack-priv long gtk_focus_out_event(long widget, long event) Overrides org.eclipse.swt.widgets.Composite.gtk_focus_out_event. Annotations @Override

gtk_focus_out_event

back to summary

pack-priv long gtk_focus_out_event(long widget, long event)

Overrides org.eclipse.swt.widgets.Composite.gtk_focus_out_event.

Annotations

@Override

gtk_preedit_changed	back to summary
pack-priv long gtk_preedit_changed(long imcontext) Overrides org.eclipse.swt.widgets.Control.gtk_preedit_changed. Annotations @Override

gtk_preedit_changed

back to summary

pack-priv long gtk_preedit_changed(long imcontext)

Overrides org.eclipse.swt.widgets.Control.gtk_preedit_changed.

Annotations

@Override

redrawWidget	back to summary
pack-priv void redrawWidget(int x, int y, int width, int height, boolean redrawAll, boolean all, boolean trim) Overrides org.eclipse.swt.widgets.Scrollable.redrawWidget. Annotations @Override

redrawWidget

back to summary

pack-priv void redrawWidget(int x, int y, int width, int height, boolean redrawAll, boolean all, boolean trim)

Overrides org.eclipse.swt.widgets.Scrollable.redrawWidget.

Annotations

@Override

releaseChildren	back to summary
pack-priv void releaseChildren(boolean destroy) Overrides org.eclipse.swt.widgets.Composite.releaseChildren. Annotations @Override

releaseChildren

back to summary

pack-priv void releaseChildren(boolean destroy)

Overrides org.eclipse.swt.widgets.Composite.releaseChildren.

Annotations

@Override

reskinChildren	back to summary
pack-priv void reskinChildren(int flags) Overrides org.eclipse.swt.widgets.Composite.reskinChildren. Annotations @Override

reskinChildren

back to summary

pack-priv void reskinChildren(int flags)

Overrides org.eclipse.swt.widgets.Composite.reskinChildren.

Annotations

@Override

scroll back to summary

scroll	back to summary
public void scroll(int destX, int destY, int x, int y, int width, int height, boolean all) Scrolls a rectangular area of the receiver by first copying the source area to the destination and then causing the area of the source which is not covered by the destination to be repainted. Children that intersect the rectangle are optionally moved during the operation. In addition, all outstanding paint events are flushed before the source area is copied to ensure that the contents of the canvas are drawn correctly. Parameters destX:int the x coordinate of the destination destY:int the y coordinate of the destination x:int the x coordinate of the source y:int the y coordinate of the source width:int the width of the area height:int the height of the area all:boolean `true`if children should be scrolled, and `false` otherwise Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

public void scroll(int destX, int destY, int x, int y, int width, int height, boolean all)

Scrolls a rectangular area of the receiver by first copying the source area to the destination and then causing the area of the source which is not covered by the destination to be repainted. Children that intersect the rectangle are optionally moved during the operation. In addition, all outstanding paint events are flushed before the source area is copied to ensure that the contents of the canvas are drawn correctly.

Parameters

destX:int: the x coordinate of the destination
destY:int: the y coordinate of the destination
x:int: the x coordinate of the source
y:int: the y coordinate of the source
width:int: the width of the area
height:int: the height of the area
all:boolean: trueif children should be scrolled, and false otherwise

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

scrollInPixels	back to summary
pack-priv void scrollInPixels(int destX, int destY, int x, int y, int width, int height, boolean all)

setBounds	back to summary
pack-priv int setBounds(int x, int y, int width, int height, boolean move, boolean resize) Overrides org.eclipse.swt.widgets.Composite.setBounds. Annotations @Override

setBounds

back to summary

pack-priv int setBounds(int x, int y, int width, int height, boolean move, boolean resize)

Overrides org.eclipse.swt.widgets.Composite.setBounds.

Annotations

@Override

setCaret	back to summary
public void setCaret(Caret caret) Sets the receiver's caret. The caret for the control is automatically hidden and shown when the control is painted or resized, when focus is gained or lost and when an the control is scrolled. To avoid drawing on top of the caret, the programmer must hide and show the caret when drawing in the window any other time. Parameters caret:Caret the new caret for the receiver, may be null Exceptions IllegalArgumentException: ERROR_INVALID_ARGUMENT - if the caret has been disposed SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setCaret

back to summary

public void setCaret(Caret caret)

Sets the receiver's caret.

Parameters

caret:Caret: the new caret for the receiver, may be null

Exceptions

IllegalArgumentException:

ERROR_INVALID_ARGUMENT - if the caret has been disposed

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setFont	back to summary
public void setFont(Font font) Overrides org.eclipse.swt.widgets.Control.setFont. Doc from org.eclipse.swt.widgets.Control.setFont. 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. Parameters font:Font the new font (or null) Annotations @Override

setFont

back to summary

public void setFont(Font font)

Overrides org.eclipse.swt.widgets.Control.setFont.

Doc from org.eclipse.swt.widgets.Control.setFont.

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.

Parameters

font:Font: the new font (or null)

Annotations

@Override

setIME	back to summary
public void setIME(IME ime) Sets the receiver's IME. Parameters ime:IME the new IME for the receiver, may be null Exceptions IllegalArgumentException: ERROR_INVALID_ARGUMENT - if the IME has been disposed SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.4

setIME

back to summary

public void setIME(IME ime)

Sets the receiver's IME.

Parameters

ime:IME: the new IME for the receiver, may be null

Exceptions

IllegalArgumentException:

ERROR_INVALID_ARGUMENT - if the IME has been disposed

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since

3.4

updateCaret	back to summary
pack-priv void updateCaret()

public Class Canvas

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail