Class EditLine
single line editor
Inherits from
-
EditWidgetBase
(base class)
Constructors
Name | Description |
---|---|
this
|
empty parameter list constructor - for usage by factory |
this
|
create with ID parameter
|
Fields
Properties
Name | Type | Description |
---|---|---|
acceleratorMap
[get]
|
ActionMap |
|
action
[get, set]
|
const(Action) |
action to emit on click
|
alignment
[set]
|
Widget |
sets alignment (combined vertical and horizontal)
|
alignment
[get]
|
ubyte |
returns alignment (combined vertical and horizontal)
|
alpha
[get]
|
uint |
widget drawing alpha value (0=opaque .. 255=transparent)
|
alpha
[set]
|
Widget |
set 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 - from string like "#5599CC" or "white" |
backgroundColor
[set]
|
Widget |
set background color for widget - override one from style
|
backgroundColor
[get]
|
uint |
returns background color |
backgroundDrawable
[get, set]
|
Ref!(dlangui.graphics.resources.Drawable) |
background drawable
|
backgroundImageId
[get, set]
|
string |
background image id
|
canCheck
[get]
|
bool |
|
canClick
[get]
|
bool |
|
canFocus
[get]
|
bool |
returns true if widget is focusable and visible and enabled
|
caretPos
[get]
|
TextPosition |
returns caret position |
checkable
[set]
|
Widget |
|
checkable
[get]
|
bool |
when true, control supports Checked state
|
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 |
|
clientRect
[get]
|
Rect |
returns client area rectangle |
content
[get]
|
EditableContent |
editor content object
|
content
[set]
|
EditWidgetBase |
set content object
|
enabled
[set]
|
Widget |
change enabled state
|
enabled
[get]
|
bool |
return true if state has State.Enabled flag set
|
focusable
[get]
|
bool |
whether widget can be focused
|
focusable
[set]
|
Widget |
|
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
[set]
|
Widget |
set font face for widget - override one from style
|
fontFace
[get]
|
string |
returns font face
|
fontFamily
[set]
|
Widget |
set font family for widget - override one from style
|
fontFamily
[get]
|
FontFamily |
returns font family
|
fontItalic
[get]
|
bool |
returns font style (italic/normal)
|
fontItalic
[set]
|
Widget |
set font style (italic /normal) for widget - override one from style
|
fontSize
[get]
|
int |
returns font size in pixels
|
fontSize
[set]
|
Widget |
set font size for widget - override one from style
|
fontWeight
[set]
|
Widget |
set font weight for widget - override one from style
|
fontWeight
[get]
|
ushort |
returns font weight
|
halign
[get]
|
Align |
returns vertical alignment
|
hasTooltip
[get]
|
bool |
returns true if widget has tooltip to show |
height
[get]
|
int |
returns current height of widget in pixels
|
hscrollbar
[get]
|
ScrollBar |
|
hscrollbar
[set]
|
ScrollBar |
|
hscrollbarMode
[set]
|
ScrollBarMode |
|
hscrollbarMode
[get]
|
ScrollBarMode |
horizontal scrollbar mode |
id
[set]
|
Widget |
set widget id
|
id
[get]
|
string |
returns widget id , null if not set
|
layoutHeight
[get]
|
int |
returns layout height options (WRAP_CONTENT, FILL_PARENT, or some constant value)
|
layoutHeight
[set]
|
Widget |
sets 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 with the same value for left , top , right, bottom - override one from style
|
margins
[set]
|
Widget |
set margins for widget - override one from style
|
margins
[get]
|
Rect |
get margins (between widget bounds and its background)
|
maxHeight
[set]
|
Widget |
set max height constraint (SIZE_UNSPECIFIED for no constraint)
|
maxHeight
[get]
|
int |
returns max height constraint (SIZE_UNSPECIFIED if no constraint set)
|
maxWidth
[set]
|
Widget |
set max width constraint (SIZE_UNSPECIFIED for no constraint)
|
maxWidth
[get]
|
int |
returns max width constraint (SIZE_UNSPECIFIED if no constraint set)
|
measuredHeight
[get]
|
int |
returns measured height (calculated during measure () call)
|
measuredWidth
[get]
|
int |
returns measured width (calculated during measure () call)
|
minHeight
[set]
|
Widget |
set max height constraint (0 for no constraint)
|
minHeight
[get]
|
int |
returns min height constraint
|
minWidth
[set]
|
Widget |
set max width constraint (0 for no constraint)
|
minWidth
[get]
|
int |
returns min width 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
[get]
|
Rect |
get padding (between background bounds and content of widget)
|
padding
[set]
|
Widget |
set padding for widget - override one from style
|
padding
[set]
|
Widget |
set padding for widget to the same value for left , top , right, bottom - override one from style
|
parent
[set]
|
Widget |
sets parent for widget
|
parent
[get]
|
Widget |
returns parent widget, null for top level widget
|
popupMenu
[get]
|
MenuItem |
|
popupMenu
[set]
|
EditWidgetBase |
|
pos
[get]
|
Rect |
returns widget rectangle |
readOnly
[get]
|
bool |
readonly flag (when true, user cannot change content of editor)
|
readOnly
[set]
|
EditWidgetBase |
sets readonly flag |
replaceMode
[get]
|
bool |
replace mode flag (when true, entered character replaces character under cursor) |
replaceMode
[set]
|
EditWidgetBase |
sets replace mode flag |
resetState
[set]
|
Widget |
remove state flags (set of flags from State enum)
|
setState
[set]
|
Widget |
add state flags (set of flags from State enum)
|
showFolding
[get, set]
|
bool |
when true, show folding controls at the left
|
showIcons
[get, set]
|
bool |
when true, show icons like bookmarks or breakpoints at the left
|
showLineNumbers
[get, set]
|
bool |
when true, line numbers are shown |
showModificationMarks
[get, set]
|
bool |
when true, show modification marks for lines (whether line is unchanged/modified/modified_saved) |
smartIndents
[get]
|
bool |
true if smart indents are enabled
|
smartIndents
[set]
|
EditWidgetBase |
set smart indents enabled flag
|
smartIndentsAfterPaste
[get]
|
bool |
true if smart indents are enabled
|
smartIndentsAfterPaste
[set]
|
EditWidgetBase |
set smart indents enabled flag
|
state
[set]
|
Widget |
set new widget state (set of flags from State enum)
|
state
[get]
|
uint |
widget state (set of flags from State enum)
|
styleId
[set]
|
Widget |
set widget style id
|
styleId
[get]
|
string |
returns widget style id , null if not set
|
supportsSmartIndents
[get]
|
bool |
true if smart indents are supported |
tabOrder
[get]
|
ushort |
tab order - hint for focus movement using Tab/Shift+Tab |
tabOrder
[set]
|
Widget |
|
tabSize
[get]
|
int |
returns tab size (in number of spaces) |
tabSize
[set]
|
EditWidgetBase |
sets tab size (in number of spaces) |
text
[set]
|
Widget |
set text
|
text
[get]
|
dstring |
get widget text
|
textColor
[get]
|
uint |
get text color (ARGB 32 bit value)
|
textColor
[set]
|
Widget |
set text color (ARGB 32 bit value )
|
textColor
[set]
|
Widget |
set text color for widget - from string like "#5599CC" or "white"
|
textFlags
[get]
|
uint |
get text flags (bit set of TextFlag enum values)
|
textFlags
[set]
|
Widget |
set text flags (bit set of TextFlag enum values)
|
tooltipText
[get, set]
|
dstring |
tooltip text - when not empty, widget will show tooltips automatically; for advanced tooltips - override hasTooltip and createTooltip
|
top
[get]
|
int |
returns widget rectangle top position
|
trackHover
[set]
|
Widget |
set new trackHover flag value (when true, widget will change Hover state while mouse is moving)
|
trackHover
[get]
|
bool |
mouse movement processing flag (when true, widget will change Hover state while mouse is moving)
|
useSpacesForTabs
[get]
|
bool |
when true, spaces will be inserted instead of tabs |
useSpacesForTabs
[set]
|
EditWidgetBase |
set new Tab key behavior flag: when true, spaces will be inserted instead of tabs |
valign
[get]
|
Align |
returns horizontal alignment
|
visibility
[get]
|
Visibility |
returns widget visibility (Visible, Invisible, Gone)
|
visibility
[set]
|
Widget |
sets widget visibility (Visible, Invisible, Gone)
|
visible
[get]
|
bool |
returns true if this widget and all its parents are visible
|
vscrollbar
[get]
|
ScrollBar |
|
vscrollbar
[set]
|
ScrollBar |
|
vscrollbarMode
[set]
|
ScrollBarMode |
|
vscrollbarMode
[get]
|
ScrollBarMode |
vertical scrollbar mode |
wantsKeyTracking
[get]
|
bool |
override and return true to track key events even when not focused
|
wantTabs
[get]
|
bool |
when true, Tab / Shift+Tab presses are processed internally in widget (e.g. insert tab character) instead of focus change navigation. |
wantTabs
[set]
|
EditWidgetBase |
sets tab size (in number of spaces) |
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?
|
wordWrap
[get, set]
|
bool |
true if word wrap mode is set |
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 |
---|---|
handleAction
|
override to handle specific actions |
layout
|
Set widget rectangle to specified value and layout widget contents. (Step 2 of two phase layout ).
|
measure
|
measure
|
onDraw
|
draw content
|
onKeyEvent
|
handle keys |
onMouseEvent
|
process mouse event ; return true if event is processed by widget.
|
addChild
|
adds child , returns added item
|
addChildren
|
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
|
cancelLayout
|
|
cancelTimer
|
cancel timer - pass value returned from setTimer () as timerId parameter
|
canShowPopupMenu
|
returns true if widget can show popup (e.g. by mouse right click at point x ,y )
|
child
|
returns child by index
|
childById
|
find child of specified type T by id , returns null if not found or cannot be converted to type T
|
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
|
createTooltip
|
will be called from window once tooltip request timer expired; if null is returned, popup will not be shown; you can change alignment and position of popup here
|
dispatchAction
|
call to dispatch action
|
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 |
getCursorType
|
returns mouse cursor type for widget |
getSelectedText
|
|
handleActionStateChanged
|
called when state of action assigned on widget is changed
|
handleActionStateRequest
|
override to handle specific actions state (e.g. change enabled state for supported actions)
|
handleMoveFocusUsingKeys
|
|
invalidate
|
request redraw |
isActionEnabled
|
override to change popup menu items state
|
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 |
makeRectVisible
|
|
onContentChange
|
|
onEvent
|
handle custom event
|
onHScroll
|
process horizontal scrollbar event
|
onMenuItemAction
|
|
onPopupMenuItem
|
|
onScrollEvent
|
handle scroll event
|
onThemeChanged
|
handle theme change: e.g. reload some themed resources |
onTimer
|
handle timer; return true to repeat timer event after next interval, false cancel timer |
onVScroll
|
process vertical scrollbar event
|
removeAllChildren
|
|
removeChild
|
removes child , returns removed item
|
removeChild
|
removes child by ID , returns removed item
|
removeChild
|
removes child , returns removed item
|
requestActionsUpdate
|
set action update request flag, will be cleared after redraw
|
requestLayout
|
request relayout of widget and its children |
setBoolProperty
|
set string property value , for ML loaders
|
setCaretPos
|
change caret position and ensure it is visible
|
setDoubleProperty
|
set double property value , for ML loaders
|
setDstringProperty
|
set string property value , for ML loaders
|
setFocus
|
sets focus to this widget or suitable focusable child , returns previously focused widget
|
setIntProperty
|
set int property value , for ML loaders
|
setRectProperty
|
set Rect property value , for ML loaders
|
setStringProperty
|
set string property value , for ML loaders
|
setTimer
|
set new timer to call onTimer () after specified interval (for recurred notifications, return true from onTimer )
|
setUistringProperty
|
set string property value , for ML loaders
|
showPopupMenu
|
shows popup at (x ,y )
|
updateActionState
|
call to update state for action (if action is assigned for widget)
|
updateActionState
|
ask for update state of some action (unles force =true, checks window flag actionsUpdateRequested), returns true if action state is changed
|
updateStateFromAction
|
apply enabled , visibile and checked state for this widget from action 's state
|
wrapLine
|
|
clientToTextPos
|
|
drawLineBackground
|
override to custom highlight of line background |
ensureCaretVisible
|
|
measureVisibleText
|
|
textPosToClient
|
|
calcLineWidth
|
|
cancelHoverTimer
|
|
caretRect
|
returns cursor rectangle |
correctCaretPos
|
when cursor position or selection is out of content bounds, fix it to nearest valid position
|
drawCaret
|
draws caret |
drawClient
|
|
drawExtendedArea
|
|
drawLeftPane
|
|
drawLeftPaneFolding
|
|
drawLeftPaneIcon
|
|
drawLeftPaneIcons
|
|
drawLeftPaneLineNumbers
|
|
drawLeftPaneModificationMarks
|
|
findKeyAction
|
map key to action
|
getLeftPaneIconsPopupMenu
|
|
handleCheckChange
|
override to handle check changes |
handleClick
|
|
handleClientRectLayout
|
override to support modification of client rect after change, e.g. apply offset |
handleFocusChange
|
override to handle focus changes |
handleLeftPaneFoldingMouseClick
|
|
handleLeftPaneIconsMouseClick
|
|
handleLeftPaneLineNumbersMouseClick
|
|
handleLeftPaneModificationMarksMouseClick
|
|
handleLeftPaneMouseClick
|
|
indentLine
|
change line indent |
indentRange
|
indent / unindent range |
lineCount
|
override for multiline editors |
measuredContent
|
helper function for implement measure () when widget's content dimensions are known
|
multipleLinesSelected
|
returns true if one or more lines selected fully |
onControlClick
|
Handle Ctrl + Left mouse click on text
|
onHover
|
|
onHoverTimeout
|
override to handle mouse hover timeout in text
|
onLeftPaneMouseClick
|
|
processSmartIndent
|
|
removeRangeText
|
|
removeSelectionTextIfSelected
|
|
scheduleTooltip
|
schedule tooltip |
selectWordByMouse
|
|
spaceBefore
|
|
spacesForTab
|
generate string of spaces, to reach next tab position |
startCaretBlinking
|
|
stopCaretBlinking
|
|
updateCaretPositionByMouse
|
|
updateFontProps
|
|
updateHScrollBar
|
update horizontal scrollbar widget position |
updateLeftPaneWidth
|
override to add custom items on left panel
|
updateMaxLineWidth
|
|
updateScrollBars
|
update scrollbar positions |
updateSelectionAfterCursorMovement
|
|
updateVScrollBar
|
update verticat scrollbar widget position |
Authors
Vadim Lopatin, coolreader.org@gmail.com
Copyright
Vadim Lopatin, 2014
License
Boost License 1.0