Class EditWidgetBase
base for all editor widgets
Inherits from
-
(base class)ScrollWidgetBase
-
EditableContentListener
-
MenuItemActionHandler
Constructors
Name | Description |
---|---|
this
|
Fields
Name | Type | Description |
---|---|---|
FOCUS_RECT_PADDING
|
immutable(int) |
|
onCheckChangeListener
|
Signal!(dlangui.widgets.widget.OnCheckHandler) |
checked state change event listener (bool delegate(Widget , bool))
|
onClickListener
|
Signal!(dlangui.widgets.widget.OnClickHandler) |
on click event listener (bool delegate(Widget ))
|
onFocusChangeListener
|
Signal!(dlangui.widgets.widget.OnFocusHandler) |
focus state change event listener (bool delegate(Widget , bool))
|
onKeyListener
|
Signal!(dlangui.widgets.widget.OnKeyHandler) |
key event listener (bool delegate(Widget , KeyEvent)) - return true if event is processed by handler
|
onMouseListener
|
Signal!(dlangui.widgets.widget.OnMouseHandler) |
mouse event listener (bool delegate(Widget , MouseEvent)) - return true if event is processed by handler
|
_camelCasePartsAsWords
|
bool |
|
_caretPos
|
TextPosition |
|
_content
|
EditableContent |
|
_fixedFont
|
bool |
|
_foldingPaneWidth
|
uint |
|
_foldingWidth
|
int |
|
_iconsPaneWidth
|
uint |
|
_iconsWidth
|
int |
|
_leftPaneBackgroundColor
|
uint |
|
_leftPaneBackgroundColor2
|
uint |
|
_leftPaneBackgroundColor3
|
uint |
|
_leftPaneLineNumberBackgroundColor
|
uint |
|
_leftPaneLineNumberColor
|
uint |
|
_leftPaneWidth
|
int |
|
_lineHeight
|
int |
|
_lineNumbersWidth
|
int |
|
_maxFontSize
|
int |
|
_minFontSize
|
int |
|
_modificationMarksPaneWidth
|
uint |
|
_modificationMarksWidth
|
int |
|
_ownContent
|
bool |
when ownContent is false, content should not be destroyed in editor destructor |
_popupMenu
|
MenuItem |
|
_replaceMode
|
bool |
|
_scrollPos
|
Point |
|
_selectionColorFocused
|
uint |
|
_selectionColorNormal
|
uint |
|
_selectionRange
|
TextRange |
|
_showFolding
|
bool |
|
_showIcons
|
bool |
|
_showLineNumbers
|
bool |
|
_showModificationMarks
|
bool |
|
_spaceWidth
|
int |
|
_tabSize
|
int |
|
_useSpacesForTabs
|
bool |
|
_wantTabs
|
bool |
|
_acceleratorMap
|
ActionMap |
|
_action
|
Action |
|
_checkable
|
bool |
|
_checked
|
bool |
|
_children
|
ObjectList!(dlangui.widgets.widget.Widget) |
|
_clickable
|
bool |
|
_clientRect
|
Rect |
inner area, excluding additional controls like scrollbars |
_focusable
|
bool |
|
_focusGroup
|
bool |
|
_fullScrollableArea
|
Rect |
|
_hscrollbar
|
ScrollBar |
horizontal scrollbar control |
_hscrollbarMode
|
ScrollBarMode |
|
_id
|
string |
widget id
|
_measuredHeight
|
int |
height measured by measure ()
|
_measuredWidth
|
int |
width measured by measure ()
|
_needDraw
|
bool |
true to force redraw |
_needLayout
|
bool |
true to force layout
|
_ownStyle
|
Style |
own copy of style - to override some of style properties, null of no properties overriden
|
_parent
|
Widget |
parent widget
|
_pos
|
Rect |
current widget position, set by layout ()
|
_state
|
uint |
widget state (set of flags from State enum)
|
_styleId
|
string |
style id to lookup style in theme
|
_tabOrder
|
ushort |
|
_trackHover
|
bool |
does widget need to track mouse Hover |
_visibility
|
Visibility |
widget visibility : either Visible, Invisible, Gone
|
_visibleScrollableArea
|
Rect |
|
_vscrollbar
|
ScrollBar |
vertical scrollbar control |
_vscrollbarMode
|
ScrollBarMode |
|
_window
|
Window |
window (to be used for top level widgets only!)
|
Properties
Name | Type | Description |
---|---|---|
canFocus
[get]
|
bool |
returns true if widget is focusable and visible and enabled
|
content
[set]
|
EditWidgetBase |
set content object
|
content
[get]
|
EditableContent |
editor content object
|
popupMenu
[get]
|
MenuItem |
|
popupMenu
[set]
|
EditWidgetBase |
|
readOnly
[get]
|
bool |
readonly flag (when true, user cannot change content of editor)
|
readOnly
[set]
|
EditWidgetBase |
sets readonly flag |
replaceMode
[set]
|
EditWidgetBase |
sets replace mode flag |
replaceMode
[get]
|
bool |
replace mode flag (when true, entered character replaces character under cursor) |
showLineNumbers
[get, set]
|
bool |
when true, line numbers are shown |
tabSize
[set]
|
EditWidgetBase |
sets tab size (in number of spaces) |
tabSize
[get]
|
int |
returns tab size (in number of spaces) |
text
[get]
|
dstring |
get widget text
|
text
[set]
|
Widget |
set text
|
useSpacesForTabs
[set]
|
EditWidgetBase |
set new Tab key behavior flag: when true, spaces will be inserted instead of tabs |
useSpacesForTabs
[get]
|
bool |
when true, spaces will be inserted instead of tabs |
wantTabs
[set]
|
EditWidgetBase |
sets tab size (in number of spaces) |
wantTabs
[get]
|
bool |
when true, Tab / Shift+Tab presses are processed internally in widget (e.g. insert tab character) instead of focus change navigation. |
acceleratorMap
[get]
|
ActionMap |
|
action
[get, set]
|
const(Action) |
action to emit on click
|
alignment
[get]
|
ubyte |
returns alignment (combined vertical and horizontal)
|
alignment
[set]
|
Widget |
sets alignment (combined vertical and horizontal)
|
alpha
[set]
|
Widget |
set widget drawing alpha value (0=opaque .. 255=transparent)
|
alpha
[get]
|
uint |
widget drawing alpha value (0=opaque .. 255=transparent)
|
animating
[get]
|
bool |
returns true is widget is being animated - need to call animate () and redraw
|
backgroundColor
[set]
|
Widget |
set background color for widget - override one from style
|
backgroundColor
[get]
|
uint |
returns background color |
backgroundDrawable
[get]
|
Ref!(dlangui.graphics.resources.Drawable) |
background drawable |
backgroundImageId
[get, set]
|
string |
background image id
|
canCheck
[get]
|
bool |
|
canClick
[get]
|
bool |
|
checkable
[get]
|
bool |
when true, control supports Checked state
|
checkable
[set]
|
Widget |
|
checked
[set]
|
Widget |
set checked state
|
checked
[get]
|
bool |
get checked state
|
childCount
[get]
|
int |
returns number of children of this widget |
clickable
[get]
|
bool |
when true, user can click this control, and get onClick listeners called |
clickable
[set]
|
Widget |
|
enabled
[set]
|
Widget |
change enabled state
|
enabled
[get]
|
bool |
return true if state has State.Enabled flag set
|
focusable
[set]
|
Widget |
|
focusable
[get]
|
bool |
whether widget can be focused
|
focused
[get]
|
bool |
|
focusGroup
[get]
|
bool |
When focus group is set for some parent widget, focus from one of containing widgets can be moved using keyboard only to one of other widgets containing in it and cannot bypass bounds of focusGroup .
|
focusGroup
[set]
|
Widget |
set focus group flag for container widget |
focusRectColors
[get]
|
const(uint[]) |
returns colors to draw focus rectangle (one for solid, two for vertical gradient) or null if no focus rect should be drawn for style
|
font
[get]
|
Ref!(dlangui.graphics.fonts.Font) |
returns font set for widget using style or set manually
|
fontFace
[get]
|
string |
returns font face
|
fontFace
[set]
|
Widget |
set font face for widget - override one from style
|
fontFamily
[get]
|
FontFamily |
returns font family
|
fontFamily
[set]
|
Widget |
set font family for widget - override one from style
|
fontItalic
[set]
|
Widget |
set font style (italic /normal) for widget - override one from style
|
fontItalic
[get]
|
bool |
returns font style (italic/normal)
|
fontSize
[get]
|
ushort |
returns font size in pixels
|
fontSize
[set]
|
Widget |
set font size for widget - override one from style
|
fontWeight
[get]
|
ushort |
returns font weight
|
fontWeight
[set]
|
Widget |
set font weight for widget - override one from style
|
halign
[get]
|
Align |
returns vertical alignment
|
height
[get]
|
int |
returns current height of widget in pixels
|
id
[get]
|
string |
returns widget id , null if not set
|
id
[set]
|
Widget |
set widget id
|
layoutHeight
[set]
|
Widget |
sets layout height options (WRAP_CONTENT, FILL_PARENT, or some constant value )
|
layoutHeight
[get]
|
int |
returns layout height options (WRAP_CONTENT, FILL_PARENT, or some constant value)
|
layoutWeight
[get]
|
int |
returns layout weight (while resizing to fill parent , widget will be resized proportionally to this value)
|
layoutWeight
[set]
|
Widget |
sets layout weight (while resizing to fill parent , widget will be resized proportionally to this value )
|
layoutWidth
[set]
|
Widget |
sets layout width options (WRAP_CONTENT, FILL_PARENT, or some constant value )
|
layoutWidth
[get]
|
int |
returns layout width options (WRAP_CONTENT, FILL_PARENT, or some constant value)
|
left
[get]
|
int |
returns widget rectangle left position
|
margins
[set]
|
Widget |
set margins for widget - override one from style
|
margins
[get]
|
Rect |
get margins (between widget bounds and its background)
|
maxHeight
[get]
|
int |
returns max height constraint (SIZE_UNSPECIFIED if no constraint set)
|
maxHeight
[set]
|
Widget |
set max height constraint (SIZE_UNSPECIFIED for no constraint)
|
maxWidth
[get]
|
int |
returns max width constraint (SIZE_UNSPECIFIED if no constraint set)
|
maxWidth
[set]
|
Widget |
set max width constraint (SIZE_UNSPECIFIED for no constraint)
|
measuredHeight
[get]
|
int |
returns measured height (calculated during measure () call)
|
measuredWidth
[get]
|
int |
returns measured width (calculated during measure () call)
|
minHeight
[get]
|
int |
returns min height constraint
|
minHeight
[set]
|
Widget |
set max height constraint (0 for no constraint)
|
minWidth
[get]
|
int |
returns min width constraint
|
minWidth
[set]
|
Widget |
set max width constraint (0 for no constraint)
|
needDraw
[get]
|
bool |
returns true if redraw is required for widget and its children |
needLayout
[get]
|
bool |
returns true if layout is required for widget and its children
|
padding
[set]
|
Widget |
set padding for widget - override one from style
|
padding
[get]
|
Rect |
get padding (between background bounds and content of widget)
|
parent
[get]
|
Widget |
returns parent widget, null for top level widget
|
parent
[set]
|
Widget |
sets parent for widget
|
pos
[get]
|
Rect |
returns widget rectangle |
resetState
[set]
|
Widget |
remove state flags (set of flags from State enum)
|
setState
[set]
|
Widget |
add state flags (set of flags from State enum)
|
state
[get]
|
uint |
widget state (set of flags from State enum)
|
state
[set]
|
Widget |
set new widget state (set of flags from State enum)
|
styleId
[get]
|
string |
returns widget style id , null if not set
|
styleId
[set]
|
Widget |
set widget style id
|
tabOrder
[set]
|
Widget |
|
tabOrder
[get]
|
ushort |
tab order - hint for focus movement using Tab/Shift+Tab |
textColor
[set]
|
Widget |
set text color (ARGB 32 bit value )
|
textColor
[get]
|
uint |
get text color (ARGB 32 bit value)
|
textFlags
[get]
|
uint |
get text flags (bit set of TextFlag enum values)
|
textFlags
[set]
|
Widget |
set text flags (bit set of TextFlag enum values)
|
top
[get]
|
int |
returns widget rectangle top position
|
trackHover
[get]
|
bool |
mouse movement processing flag (when true, widget will change Hover state while mouse is moving)
|
trackHover
[set]
|
Widget |
set new trackHover flag value (when true, widget will change Hover state while mouse is moving)
|
valign
[get]
|
Align |
returns horizontal alignment
|
visibility
[set]
|
Widget |
sets widget visibility (Visible, Invisible, Gone)
|
visibility
[get]
|
Visibility |
returns widget visibility (Visible, Invisible, Gone)
|
visible
[get]
|
bool |
returns true if this widget and all its parents are visible
|
wantsKeyTracking
[get]
|
bool |
override and return true to track key events even when not focused
|
width
[get]
|
int |
returns current width of widget in pixels
|
window
[get]
|
Window |
returns window (if widget or its parent is attached to window )
|
window
[set]
|
Window |
sets window (to be used for top level widget from Window implementation). TODO: hide it from API?
|
ownStyle
[get]
|
Style |
enforces widget's own style - allows override some of style properties
|
stateStyle
[get]
|
const(Style) |
returns style for current widget state
|
style
[get, set]
|
const(Style) |
accessor to style - by lookup in theme by styleId (if style id is not set, theme base style will be used).
|
Methods
Name | Description |
---|---|
canShowPopupMenu
|
returns true if widget can show popup (e.g. by mouse right click at point x ,y )
|
getCursorType
|
returns mouse cursor type for widget |
isActionEnabled
|
override to change popup menu items state
|
onContentChange
|
|
onKeyEvent
|
handle keys |
onMenuItemAction
|
|
onMouseEvent
|
process mouse event ; return true if event is processed by widget.
|
onPopupMenuItem
|
|
showPopupMenu
|
shows popup at (x ,y )
|
addChild
|
adds child , returns added item
|
addOnCheckChangeListener
|
helper function to add onCheckChangeListener in method chain
|
addOnClickListener
|
helper function to add onCheckChangeListener in method chain
|
addOnFocusChangeListener
|
helper function to add onFocusChangeListener in method chain
|
animate
|
animates window ; interval is time left from previous draw, in hnsecs (1/10000000 of second)
|
applyAlign
|
Applies alignment for content of size sz - set rectangle rc to aligned value of content inside of initial value of rc .
|
applyMargins
|
Helper function: applies margins to rectangle
|
applyPadding
|
Helper function: applies padding to rectangle
|
child
|
returns child by index
|
childById
|
find child by id , returns null if not found
|
childIndex
|
returns index of widget in child list, -1 if passed widget is not a child of this widget
|
compareId
|
compare widget id with specified value, returs true if matches
|
drawFocusRect
|
draws focus rectangle, if enabled in styles
|
executeInUiThread
|
execute delegate later in UI thread if this widget will be still available (can be used to modify UI from background thread, or just to postpone execution of action )
|
findFocusableChild
|
searches children for first focusable item, returns null if not found
|
focusGroupWidget
|
find nearest parent of this widget with focusGroup flag, returns topmost parent if no focusGroup flag set to any of parents.
|
fullContentSize
|
calculate full content size in pixels |
handleMoveFocusUsingKeys
|
|
invalidate
|
request redraw |
isChild
|
returns true if item is child of this widget (when deepSearch == true - returns true if item is this widget or one of children inside children tree).
|
isPointInside
|
returns true if point is inside of this widget |
layout
|
Set widget rectangle to specified value and layout widget contents. (Step 2 of two phase layout ).
|
makeRectVisible
|
|
measure
|
Measure widget according to desired width and height constraints. (Step 1 of two phase layout ).
|
onDraw
|
Draw widget at its position to buffer |
onEvent
|
handle custom event
|
onHScroll
|
process horizontal scrollbar event
|
onScrollEvent
|
handle scroll event
|
onVScroll
|
process vertical scrollbar event
|
removeAllChildren
|
|
removeChild
|
removes child by ID , returns removed item
|
removeChild
|
removes child , returns removed item
|
requestLayout
|
request relayout of widget and its children |
setFocus
|
sets focus to this widget or suitable focusable child , returns previously focused widget
|
calcLineWidth
|
|
caretRect
|
returns cursor rectangle |
clientToTextPos
|
|
correctCaretPos
|
when cursor position or selection is out of content bounds, fix it to nearest valid position
|
drawCaret
|
draws caret |
drawLeftPane
|
|
drawLeftPaneFolding
|
|
drawLeftPaneIcons
|
|
drawLeftPaneLineNumbers
|
|
drawLeftPaneModificationMarks
|
|
ensureCaretVisible
|
|
findKeyAction
|
map key to action
|
handleAction
|
override to handle specific actions |
handleClientRectLayout
|
override to support modification of client rect after change, e.g. apply offset |
indentLine
|
change line indent |
indentRange
|
indent / unindent range |
lineCount
|
override for multiline editors |
measureVisibleText
|
|
removeRangeText
|
|
removeSelectionTextIfSelected
|
|
spaceBefore
|
|
spacesForTab
|
generate string of spaces, to reach next tab position |
textPosToClient
|
|
updateCaretPositionByMouse
|
|
updateFontProps
|
|
updateLeftPaneWidth
|
override to add custom items on left panel
|
updateMaxLineWidth
|
|
updateSelectionAfterCursorMovement
|
|
wholeLinesSelected
|
returns true if one or more lines selected fully |
drawClient
|
|
drawExtendedArea
|
|
handleCheckChange
|
override to handle check changes |
handleClick
|
|
handleFocusChange
|
override to handle focus changes |
measuredContent
|
helper function for implement measure () when widget's content dimensions are known
|
updateHScrollBar
|
update horizontal scrollbar widget position |
updateScrollBars
|
update scrollbar positions |
updateVScrollBar
|
update verticat scrollbar widget position |
Authors
Vadim Lopatin, coolreader.org@gmail.com
Copyright
Vadim Lopatin, 2014
License
Boost License 1.0