Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- getAutoIndent
- getBackgroundPattern
- getCompletion
- getDrawSpaces
- getGutter
- getHighlightCurrentLine
- getIndentOnTab
- getIndentWidth
- getInsertSpacesInsteadOfTabs
- getMarkAttributes
- getRightMarginPosition
- getShowLineMarks
- getShowLineNumbers
- getShowRightMargin
- getSmartBackspace
- getSmartHomeEnd
- getSpaceDrawer
- getTabWidth
- getVisualColumn
- indentLines
- new
- newWithBuffer
- setAutoIndent
- setBackgroundPattern
- setDrawSpaces
- setHighlightCurrentLine
- setIndentOnTab
- setIndentWidth
- setInsertSpacesInsteadOfTabs
- setMarkAttributes
- setRightMarginPosition
- setShowLineMarks
- setShowLineNumbers
- setShowRightMargin
- setSmartBackspace
- setSmartHomeEnd
- setTabWidth
- unindentLines
- Properties
- Signals
- newtype View = View (ManagedPtr View)
- class GObject o => IsView o
- toView :: (MonadIO m, IsView o) => o -> m View
- noView :: Maybe View
- viewGetAutoIndent :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetBackgroundPattern :: (HasCallStack, MonadIO m, IsView a) => a -> m BackgroundPatternType
- viewGetCompletion :: (HasCallStack, MonadIO m, IsView a) => a -> m Completion
- viewGetDrawSpaces :: (HasCallStack, MonadIO m, IsView a) => a -> m [DrawSpacesFlags]
- viewGetGutter :: (HasCallStack, MonadIO m, IsView a) => a -> TextWindowType -> m Gutter
- viewGetHighlightCurrentLine :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetIndentOnTab :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetIndentWidth :: (HasCallStack, MonadIO m, IsView a) => a -> m Int32
- viewGetInsertSpacesInsteadOfTabs :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetMarkAttributes :: (HasCallStack, MonadIO m, IsView a) => a -> Text -> Int32 -> m MarkAttributes
- viewGetRightMarginPosition :: (HasCallStack, MonadIO m, IsView a) => a -> m Word32
- viewGetShowLineMarks :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetShowLineNumbers :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetShowRightMargin :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetSmartBackspace :: (HasCallStack, MonadIO m, IsView a) => a -> m Bool
- viewGetSmartHomeEnd :: (HasCallStack, MonadIO m, IsView a) => a -> m SmartHomeEndType
- viewGetSpaceDrawer :: (HasCallStack, MonadIO m, IsView a) => a -> m SpaceDrawer
- viewGetTabWidth :: (HasCallStack, MonadIO m, IsView a) => a -> m Word32
- viewGetVisualColumn :: (HasCallStack, MonadIO m, IsView a) => a -> TextIter -> m Word32
- viewIndentLines :: (HasCallStack, MonadIO m, IsView a) => a -> TextIter -> TextIter -> m ()
- viewNew :: (HasCallStack, MonadIO m) => m View
- viewNewWithBuffer :: (HasCallStack, MonadIO m, IsBuffer a) => a -> m View
- viewSetAutoIndent :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetBackgroundPattern :: (HasCallStack, MonadIO m, IsView a) => a -> BackgroundPatternType -> m ()
- viewSetDrawSpaces :: (HasCallStack, MonadIO m, IsView a) => a -> [DrawSpacesFlags] -> m ()
- viewSetHighlightCurrentLine :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetIndentOnTab :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetIndentWidth :: (HasCallStack, MonadIO m, IsView a) => a -> Int32 -> m ()
- viewSetInsertSpacesInsteadOfTabs :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetMarkAttributes :: (HasCallStack, MonadIO m, IsView a, IsMarkAttributes b) => a -> Text -> b -> Int32 -> m ()
- viewSetRightMarginPosition :: (HasCallStack, MonadIO m, IsView a) => a -> Word32 -> m ()
- viewSetShowLineMarks :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetShowLineNumbers :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetShowRightMargin :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetSmartBackspace :: (HasCallStack, MonadIO m, IsView a) => a -> Bool -> m ()
- viewSetSmartHomeEnd :: (HasCallStack, MonadIO m, IsView a) => a -> SmartHomeEndType -> m ()
- viewSetTabWidth :: (HasCallStack, MonadIO m, IsView a) => a -> Word32 -> m ()
- viewUnindentLines :: (HasCallStack, MonadIO m, IsView a) => a -> TextIter -> TextIter -> m ()
- constructViewAutoIndent :: IsView o => Bool -> IO (GValueConstruct o)
- getViewAutoIndent :: (MonadIO m, IsView o) => o -> m Bool
- setViewAutoIndent :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewBackgroundPattern :: IsView o => BackgroundPatternType -> IO (GValueConstruct o)
- getViewBackgroundPattern :: (MonadIO m, IsView o) => o -> m BackgroundPatternType
- setViewBackgroundPattern :: (MonadIO m, IsView o) => o -> BackgroundPatternType -> m ()
- getViewCompletion :: (MonadIO m, IsView o) => o -> m Completion
- constructViewDrawSpaces :: IsView o => [DrawSpacesFlags] -> IO (GValueConstruct o)
- getViewDrawSpaces :: (MonadIO m, IsView o) => o -> m [DrawSpacesFlags]
- setViewDrawSpaces :: (MonadIO m, IsView o) => o -> [DrawSpacesFlags] -> m ()
- constructViewHighlightCurrentLine :: IsView o => Bool -> IO (GValueConstruct o)
- getViewHighlightCurrentLine :: (MonadIO m, IsView o) => o -> m Bool
- setViewHighlightCurrentLine :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewIndentOnTab :: IsView o => Bool -> IO (GValueConstruct o)
- getViewIndentOnTab :: (MonadIO m, IsView o) => o -> m Bool
- setViewIndentOnTab :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewIndentWidth :: IsView o => Int32 -> IO (GValueConstruct o)
- getViewIndentWidth :: (MonadIO m, IsView o) => o -> m Int32
- setViewIndentWidth :: (MonadIO m, IsView o) => o -> Int32 -> m ()
- constructViewInsertSpacesInsteadOfTabs :: IsView o => Bool -> IO (GValueConstruct o)
- getViewInsertSpacesInsteadOfTabs :: (MonadIO m, IsView o) => o -> m Bool
- setViewInsertSpacesInsteadOfTabs :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewRightMarginPosition :: IsView o => Word32 -> IO (GValueConstruct o)
- getViewRightMarginPosition :: (MonadIO m, IsView o) => o -> m Word32
- setViewRightMarginPosition :: (MonadIO m, IsView o) => o -> Word32 -> m ()
- constructViewShowLineMarks :: IsView o => Bool -> IO (GValueConstruct o)
- getViewShowLineMarks :: (MonadIO m, IsView o) => o -> m Bool
- setViewShowLineMarks :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewShowLineNumbers :: IsView o => Bool -> IO (GValueConstruct o)
- getViewShowLineNumbers :: (MonadIO m, IsView o) => o -> m Bool
- setViewShowLineNumbers :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewShowRightMargin :: IsView o => Bool -> IO (GValueConstruct o)
- getViewShowRightMargin :: (MonadIO m, IsView o) => o -> m Bool
- setViewShowRightMargin :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewSmartBackspace :: IsView o => Bool -> IO (GValueConstruct o)
- getViewSmartBackspace :: (MonadIO m, IsView o) => o -> m Bool
- setViewSmartBackspace :: (MonadIO m, IsView o) => o -> Bool -> m ()
- constructViewSmartHomeEnd :: IsView o => SmartHomeEndType -> IO (GValueConstruct o)
- getViewSmartHomeEnd :: (MonadIO m, IsView o) => o -> m SmartHomeEndType
- setViewSmartHomeEnd :: (MonadIO m, IsView o) => o -> SmartHomeEndType -> m ()
- getViewSpaceDrawer :: (MonadIO m, IsView o) => o -> m SpaceDrawer
- constructViewTabWidth :: IsView o => Word32 -> IO (GValueConstruct o)
- getViewTabWidth :: (MonadIO m, IsView o) => o -> m Word32
- setViewTabWidth :: (MonadIO m, IsView o) => o -> Word32 -> m ()
- type C_ViewChangeCaseCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type ViewChangeCaseCallback = ChangeCaseType -> IO ()
- afterViewChangeCase :: (IsView a, MonadIO m) => a -> ViewChangeCaseCallback -> m SignalHandlerId
- genClosure_ViewChangeCase :: ViewChangeCaseCallback -> IO Closure
- mk_ViewChangeCaseCallback :: C_ViewChangeCaseCallback -> IO (FunPtr C_ViewChangeCaseCallback)
- noViewChangeCaseCallback :: Maybe ViewChangeCaseCallback
- onViewChangeCase :: (IsView a, MonadIO m) => a -> ViewChangeCaseCallback -> m SignalHandlerId
- wrap_ViewChangeCaseCallback :: ViewChangeCaseCallback -> Ptr () -> CUInt -> Ptr () -> IO ()
- type C_ViewChangeNumberCallback = Ptr () -> Int32 -> Ptr () -> IO ()
- type ViewChangeNumberCallback = Int32 -> IO ()
- afterViewChangeNumber :: (IsView a, MonadIO m) => a -> ViewChangeNumberCallback -> m SignalHandlerId
- genClosure_ViewChangeNumber :: ViewChangeNumberCallback -> IO Closure
- mk_ViewChangeNumberCallback :: C_ViewChangeNumberCallback -> IO (FunPtr C_ViewChangeNumberCallback)
- noViewChangeNumberCallback :: Maybe ViewChangeNumberCallback
- onViewChangeNumber :: (IsView a, MonadIO m) => a -> ViewChangeNumberCallback -> m SignalHandlerId
- wrap_ViewChangeNumberCallback :: ViewChangeNumberCallback -> Ptr () -> Int32 -> Ptr () -> IO ()
- type C_ViewJoinLinesCallback = Ptr () -> Ptr () -> IO ()
- type ViewJoinLinesCallback = IO ()
- afterViewJoinLines :: (IsView a, MonadIO m) => a -> ViewJoinLinesCallback -> m SignalHandlerId
- genClosure_ViewJoinLines :: ViewJoinLinesCallback -> IO Closure
- mk_ViewJoinLinesCallback :: C_ViewJoinLinesCallback -> IO (FunPtr C_ViewJoinLinesCallback)
- noViewJoinLinesCallback :: Maybe ViewJoinLinesCallback
- onViewJoinLines :: (IsView a, MonadIO m) => a -> ViewJoinLinesCallback -> m SignalHandlerId
- wrap_ViewJoinLinesCallback :: ViewJoinLinesCallback -> Ptr () -> Ptr () -> IO ()
- type C_ViewLineMarkActivatedCallback = Ptr () -> Ptr TextIter -> Ptr Event -> Ptr () -> IO ()
- type ViewLineMarkActivatedCallback = TextIter -> Event -> IO ()
- afterViewLineMarkActivated :: (IsView a, MonadIO m) => a -> ViewLineMarkActivatedCallback -> m SignalHandlerId
- genClosure_ViewLineMarkActivated :: ViewLineMarkActivatedCallback -> IO Closure
- mk_ViewLineMarkActivatedCallback :: C_ViewLineMarkActivatedCallback -> IO (FunPtr C_ViewLineMarkActivatedCallback)
- noViewLineMarkActivatedCallback :: Maybe ViewLineMarkActivatedCallback
- onViewLineMarkActivated :: (IsView a, MonadIO m) => a -> ViewLineMarkActivatedCallback -> m SignalHandlerId
- wrap_ViewLineMarkActivatedCallback :: ViewLineMarkActivatedCallback -> Ptr () -> Ptr TextIter -> Ptr Event -> Ptr () -> IO ()
- type C_ViewMoveLinesCallback = Ptr () -> CInt -> Int32 -> Ptr () -> IO ()
- type ViewMoveLinesCallback = Bool -> Int32 -> IO ()
- afterViewMoveLines :: (IsView a, MonadIO m) => a -> ViewMoveLinesCallback -> m SignalHandlerId
- genClosure_ViewMoveLines :: ViewMoveLinesCallback -> IO Closure
- mk_ViewMoveLinesCallback :: C_ViewMoveLinesCallback -> IO (FunPtr C_ViewMoveLinesCallback)
- noViewMoveLinesCallback :: Maybe ViewMoveLinesCallback
- onViewMoveLines :: (IsView a, MonadIO m) => a -> ViewMoveLinesCallback -> m SignalHandlerId
- wrap_ViewMoveLinesCallback :: ViewMoveLinesCallback -> Ptr () -> CInt -> Int32 -> Ptr () -> IO ()
- type C_ViewMoveToMatchingBracketCallback = Ptr () -> CInt -> Ptr () -> IO ()
- type ViewMoveToMatchingBracketCallback = Bool -> IO ()
- afterViewMoveToMatchingBracket :: (IsView a, MonadIO m) => a -> ViewMoveToMatchingBracketCallback -> m SignalHandlerId
- genClosure_ViewMoveToMatchingBracket :: ViewMoveToMatchingBracketCallback -> IO Closure
- mk_ViewMoveToMatchingBracketCallback :: C_ViewMoveToMatchingBracketCallback -> IO (FunPtr C_ViewMoveToMatchingBracketCallback)
- noViewMoveToMatchingBracketCallback :: Maybe ViewMoveToMatchingBracketCallback
- onViewMoveToMatchingBracket :: (IsView a, MonadIO m) => a -> ViewMoveToMatchingBracketCallback -> m SignalHandlerId
- wrap_ViewMoveToMatchingBracketCallback :: ViewMoveToMatchingBracketCallback -> Ptr () -> CInt -> Ptr () -> IO ()
- type C_ViewMoveWordsCallback = Ptr () -> Int32 -> Ptr () -> IO ()
- type ViewMoveWordsCallback = Int32 -> IO ()
- afterViewMoveWords :: (IsView a, MonadIO m) => a -> ViewMoveWordsCallback -> m SignalHandlerId
- genClosure_ViewMoveWords :: ViewMoveWordsCallback -> IO Closure
- mk_ViewMoveWordsCallback :: C_ViewMoveWordsCallback -> IO (FunPtr C_ViewMoveWordsCallback)
- noViewMoveWordsCallback :: Maybe ViewMoveWordsCallback
- onViewMoveWords :: (IsView a, MonadIO m) => a -> ViewMoveWordsCallback -> m SignalHandlerId
- wrap_ViewMoveWordsCallback :: ViewMoveWordsCallback -> Ptr () -> Int32 -> Ptr () -> IO ()
- type C_ViewRedoCallback = Ptr () -> Ptr () -> IO ()
- type ViewRedoCallback = IO ()
- afterViewRedo :: (IsView a, MonadIO m) => a -> ViewRedoCallback -> m SignalHandlerId
- genClosure_ViewRedo :: ViewRedoCallback -> IO Closure
- mk_ViewRedoCallback :: C_ViewRedoCallback -> IO (FunPtr C_ViewRedoCallback)
- noViewRedoCallback :: Maybe ViewRedoCallback
- onViewRedo :: (IsView a, MonadIO m) => a -> ViewRedoCallback -> m SignalHandlerId
- wrap_ViewRedoCallback :: ViewRedoCallback -> Ptr () -> Ptr () -> IO ()
- type C_ViewShowCompletionCallback = Ptr () -> Ptr () -> IO ()
- type ViewShowCompletionCallback = IO ()
- afterViewShowCompletion :: (IsView a, MonadIO m) => a -> ViewShowCompletionCallback -> m SignalHandlerId
- genClosure_ViewShowCompletion :: ViewShowCompletionCallback -> IO Closure
- mk_ViewShowCompletionCallback :: C_ViewShowCompletionCallback -> IO (FunPtr C_ViewShowCompletionCallback)
- noViewShowCompletionCallback :: Maybe ViewShowCompletionCallback
- onViewShowCompletion :: (IsView a, MonadIO m) => a -> ViewShowCompletionCallback -> m SignalHandlerId
- wrap_ViewShowCompletionCallback :: ViewShowCompletionCallback -> Ptr () -> Ptr () -> IO ()
- type C_ViewSmartHomeEndCallback = Ptr () -> Ptr TextIter -> Int32 -> Ptr () -> IO ()
- type ViewSmartHomeEndCallback = TextIter -> Int32 -> IO ()
- afterViewSmartHomeEnd :: (IsView a, MonadIO m) => a -> ViewSmartHomeEndCallback -> m SignalHandlerId
- genClosure_ViewSmartHomeEnd :: ViewSmartHomeEndCallback -> IO Closure
- mk_ViewSmartHomeEndCallback :: C_ViewSmartHomeEndCallback -> IO (FunPtr C_ViewSmartHomeEndCallback)
- noViewSmartHomeEndCallback :: Maybe ViewSmartHomeEndCallback
- onViewSmartHomeEnd :: (IsView a, MonadIO m) => a -> ViewSmartHomeEndCallback -> m SignalHandlerId
- wrap_ViewSmartHomeEndCallback :: ViewSmartHomeEndCallback -> Ptr () -> Ptr TextIter -> Int32 -> Ptr () -> IO ()
- type C_ViewUndoCallback = Ptr () -> Ptr () -> IO ()
- type ViewUndoCallback = IO ()
- afterViewUndo :: (IsView a, MonadIO m) => a -> ViewUndoCallback -> m SignalHandlerId
- genClosure_ViewUndo :: ViewUndoCallback -> IO Closure
- mk_ViewUndoCallback :: C_ViewUndoCallback -> IO (FunPtr C_ViewUndoCallback)
- noViewUndoCallback :: Maybe ViewUndoCallback
- onViewUndo :: (IsView a, MonadIO m) => a -> ViewUndoCallback -> m SignalHandlerId
- wrap_ViewUndoCallback :: ViewUndoCallback -> Ptr () -> Ptr () -> IO ()
Exported types
Methods
getAutoIndent
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether auto-indentation of text is enabled.
getBackgroundPattern
viewGetBackgroundPattern Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m BackgroundPatternType | Returns: the |
Returns the BackgroundPatternType
specifying if and how
the background pattern should be displayed for this view
.
Since: 3.16
getCompletion
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Completion | Returns: the |
Gets the Completion
associated with view
. The returned object is
guaranteed to be the same for the lifetime of view
. Each View
object has a different Completion
.
getDrawSpaces
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m [DrawSpacesFlags] | Returns: the |
Deprecated: (Since version 3.24)Use spaceDrawerGetTypesForLocations
instead.
Returns the DrawSpacesFlags
specifying if and how spaces
should be displayed for this view
.
getGutter
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> TextWindowType |
|
-> m Gutter | Returns: the |
Returns the Gutter
object associated with windowType
for view
.
Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported,
respectively corresponding to the left and right gutter. The line numbers
and mark category icons are rendered in the left gutter.
Since: 2.8
getHighlightCurrentLine
viewGetHighlightCurrentLine Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the current line is highlighted.
getIndentOnTab
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character.
getIndentWidth
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Int32 | Returns: indent width. |
Returns the number of spaces to use for each step of indent.
See viewSetIndentWidth
for details.
getInsertSpacesInsteadOfTabs
viewGetInsertSpacesInsteadOfTabs Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether when inserting a tabulator character it should be replaced by a group of space characters.
getMarkAttributes
viewGetMarkAttributes Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Text |
|
-> Int32 |
|
-> m MarkAttributes | Returns: |
Gets attributes and priority for the category
.
getRightMarginPosition
viewGetRightMarginPosition Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Word32 | Returns: the position of the right margin. |
Gets the position of the right margin in the given view
.
getShowLineMarks
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether line marks are displayed beside the text.
Since: 2.2
getShowLineNumbers
viewGetShowLineNumbers Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether line numbers are displayed beside the text.
getShowRightMargin
viewGetShowRightMargin Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether a right margin is displayed.
getSmartBackspace
viewGetSmartBackspace Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Bool | Returns: |
Returns True
if pressing the Backspace key will try to delete spaces
up to the previous tab stop.
Since: 3.18
getSmartHomeEnd
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m SmartHomeEndType | Returns: a |
Returns a SmartHomeEndType
end value specifying
how the cursor will move when HOME and END keys are pressed.
getSpaceDrawer
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m SpaceDrawer | Returns: the |
Gets the SpaceDrawer
associated with view
. The returned object is
guaranteed to be the same for the lifetime of view
. Each View
object has a different SpaceDrawer
.
Since: 3.24
getTabWidth
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> m Word32 | Returns: width of tab. |
Returns the width of tabulation in characters.
getVisualColumn
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> TextIter |
|
-> m Word32 | Returns: the visual column at |
Determines the visual column at iter
taking into consideration the
View
:tab-width
of view
.
indentLines
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> TextIter |
|
-> TextIter |
|
-> m () |
Insert one indentation level at the beginning of the specified lines.
Since: 3.16
new
:: (HasCallStack, MonadIO m) | |
=> m View | Returns: a new |
Creates a new View
.
By default, an empty Buffer
will be lazily created and can be
retrieved with textViewGetBuffer
.
If you want to specify your own buffer, either override the
TextViewClass
create_buffer factory method, or use
viewNewWithBuffer
.
newWithBuffer
Creates a new View
widget displaying the buffer
buffer
. One buffer can be shared among many widgets.
setAutoIndent
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If True
auto-indentation of text is enabled.
When Enter is pressed to create a new line, the auto-indentation inserts the same indentation as the previous line. This is <emphasis>not</emphasis> a "smart indentation" where an indentation level is added or removed depending on the context.
setBackgroundPattern
viewSetBackgroundPattern Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> BackgroundPatternType |
|
-> m () |
Set if and how the background pattern should be displayed.
Since: 3.16
setDrawSpaces
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> [DrawSpacesFlags] |
|
-> m () |
Deprecated: (Since version 3.24)Use spaceDrawerSetTypesForLocations
instead.
Set if and how the spaces should be visualized. Specifying flags
as 0 will
disable display of spaces.
For a finer-grained method, there is also the GtkSourceTag's
Tag
:draw-spaces
property.
setHighlightCurrentLine
viewSetHighlightCurrentLine Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If highlight
is True
the current line will be highlighted.
setIndentOnTab
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If True
, when the tab key is pressed when several lines are selected, the
selected lines are indented of one level instead of being replaced with a \t
character. Shift+Tab unindents the selection.
If the first or last line is not selected completely, it is also indented or unindented.
When the selection doesn't span several lines, the tab key always replaces the selection with a normal \t character.
setIndentWidth
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Int32 |
|
-> m () |
Sets the number of spaces to use for each step of indent when the tab key is
pressed. If width
is -1, the value of the View
:tab-width
property
will be used.
The View
:indent-width
interacts with the
View
:insert-spaces-instead-of-tabs
property and
View
:tab-width
. An example will be clearer: if the
View
:indent-width
is 4 and
View
:tab-width
is 8 and
View
:insert-spaces-instead-of-tabs
is False
, then pressing the tab
key at the beginning of a line will insert 4 spaces. So far so good. Pressing
the tab key a second time will remove the 4 spaces and insert a \t character
instead (since View
:tab-width
is 8). On the other hand, if
View
:insert-spaces-instead-of-tabs
is True
, the second tab key
pressed will insert 4 more spaces for a total of 8 spaces in the
TextBuffer
.
The test-widget program (available in the GtkSourceView repository) may be useful to better understand the indentation settings (enable the space drawing!).
setInsertSpacesInsteadOfTabs
viewSetInsertSpacesInsteadOfTabs Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If True
a tab key pressed is replaced by a group of space characters. Of
course it is still possible to insert a real \t programmatically with the
TextBuffer
API.
setMarkAttributes
viewSetMarkAttributes Source #
:: (HasCallStack, MonadIO m, IsView a, IsMarkAttributes b) | |
=> a |
|
-> Text |
|
-> b |
|
-> Int32 |
|
-> m () |
Sets attributes and priority for the category
.
setRightMarginPosition
viewSetRightMarginPosition Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Word32 |
|
-> m () |
Sets the position of the right margin in the given view
.
setShowLineMarks
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If True
line marks will be displayed beside the text.
Since: 2.2
setShowLineNumbers
viewSetShowLineNumbers Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If True
line numbers will be displayed beside the text.
setShowRightMargin
viewSetShowRightMargin Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
If True
a right margin is displayed.
setSmartBackspace
viewSetSmartBackspace Source #
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Bool |
|
-> m () |
When set to True
, pressing the Backspace key will try to delete spaces
up to the previous tab stop.
Since: 3.18
setSmartHomeEnd
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> SmartHomeEndType |
|
-> m () |
Set the desired movement of the cursor when HOME and END keys are pressed.
setTabWidth
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> Word32 |
|
-> m () |
Sets the width of tabulation in characters. The TextBuffer
still contains
\t characters, but they can take a different visual width in a View
widget.
unindentLines
:: (HasCallStack, MonadIO m, IsView a) | |
=> a |
|
-> TextIter |
|
-> TextIter |
|
-> m () |
Removes one indentation level at the beginning of the specified lines.
Since: 3.16
Properties
autoIndent
constructViewAutoIndent :: IsView o => Bool -> IO (GValueConstruct o) Source #
backgroundPattern
constructViewBackgroundPattern :: IsView o => BackgroundPatternType -> IO (GValueConstruct o) Source #
getViewBackgroundPattern :: (MonadIO m, IsView o) => o -> m BackgroundPatternType Source #
setViewBackgroundPattern :: (MonadIO m, IsView o) => o -> BackgroundPatternType -> m () Source #
completion
getViewCompletion :: (MonadIO m, IsView o) => o -> m Completion Source #
drawSpaces
constructViewDrawSpaces :: IsView o => [DrawSpacesFlags] -> IO (GValueConstruct o) Source #
getViewDrawSpaces :: (MonadIO m, IsView o) => o -> m [DrawSpacesFlags] Source #
setViewDrawSpaces :: (MonadIO m, IsView o) => o -> [DrawSpacesFlags] -> m () Source #
highlightCurrentLine
constructViewHighlightCurrentLine :: IsView o => Bool -> IO (GValueConstruct o) Source #
indentOnTab
constructViewIndentOnTab :: IsView o => Bool -> IO (GValueConstruct o) Source #
indentWidth
constructViewIndentWidth :: IsView o => Int32 -> IO (GValueConstruct o) Source #
insertSpacesInsteadOfTabs
constructViewInsertSpacesInsteadOfTabs :: IsView o => Bool -> IO (GValueConstruct o) Source #
rightMarginPosition
constructViewRightMarginPosition :: IsView o => Word32 -> IO (GValueConstruct o) Source #
showLineMarks
constructViewShowLineMarks :: IsView o => Bool -> IO (GValueConstruct o) Source #
showLineNumbers
constructViewShowLineNumbers :: IsView o => Bool -> IO (GValueConstruct o) Source #
showRightMargin
constructViewShowRightMargin :: IsView o => Bool -> IO (GValueConstruct o) Source #
smartBackspace
constructViewSmartBackspace :: IsView o => Bool -> IO (GValueConstruct o) Source #
smartHomeEnd
constructViewSmartHomeEnd :: IsView o => SmartHomeEndType -> IO (GValueConstruct o) Source #
getViewSmartHomeEnd :: (MonadIO m, IsView o) => o -> m SmartHomeEndType Source #
setViewSmartHomeEnd :: (MonadIO m, IsView o) => o -> SmartHomeEndType -> m () Source #
spaceDrawer
getViewSpaceDrawer :: (MonadIO m, IsView o) => o -> m SpaceDrawer Source #
tabWidth
constructViewTabWidth :: IsView o => Word32 -> IO (GValueConstruct o) Source #
Signals
changeCase
type ViewChangeCaseCallback = ChangeCaseType -> IO () Source #
afterViewChangeCase :: (IsView a, MonadIO m) => a -> ViewChangeCaseCallback -> m SignalHandlerId Source #
mk_ViewChangeCaseCallback :: C_ViewChangeCaseCallback -> IO (FunPtr C_ViewChangeCaseCallback) Source #
onViewChangeCase :: (IsView a, MonadIO m) => a -> ViewChangeCaseCallback -> m SignalHandlerId Source #
wrap_ViewChangeCaseCallback :: ViewChangeCaseCallback -> Ptr () -> CUInt -> Ptr () -> IO () Source #
changeNumber
type ViewChangeNumberCallback = Int32 -> IO () Source #
afterViewChangeNumber :: (IsView a, MonadIO m) => a -> ViewChangeNumberCallback -> m SignalHandlerId Source #
mk_ViewChangeNumberCallback :: C_ViewChangeNumberCallback -> IO (FunPtr C_ViewChangeNumberCallback) Source #
onViewChangeNumber :: (IsView a, MonadIO m) => a -> ViewChangeNumberCallback -> m SignalHandlerId Source #
wrap_ViewChangeNumberCallback :: ViewChangeNumberCallback -> Ptr () -> Int32 -> Ptr () -> IO () Source #
joinLines
type ViewJoinLinesCallback = IO () Source #
afterViewJoinLines :: (IsView a, MonadIO m) => a -> ViewJoinLinesCallback -> m SignalHandlerId Source #
onViewJoinLines :: (IsView a, MonadIO m) => a -> ViewJoinLinesCallback -> m SignalHandlerId Source #
wrap_ViewJoinLinesCallback :: ViewJoinLinesCallback -> Ptr () -> Ptr () -> IO () Source #
lineMarkActivated
type C_ViewLineMarkActivatedCallback = Ptr () -> Ptr TextIter -> Ptr Event -> Ptr () -> IO () Source #
afterViewLineMarkActivated :: (IsView a, MonadIO m) => a -> ViewLineMarkActivatedCallback -> m SignalHandlerId Source #
mk_ViewLineMarkActivatedCallback :: C_ViewLineMarkActivatedCallback -> IO (FunPtr C_ViewLineMarkActivatedCallback) Source #
onViewLineMarkActivated :: (IsView a, MonadIO m) => a -> ViewLineMarkActivatedCallback -> m SignalHandlerId Source #
wrap_ViewLineMarkActivatedCallback :: ViewLineMarkActivatedCallback -> Ptr () -> Ptr TextIter -> Ptr Event -> Ptr () -> IO () Source #
moveLines
afterViewMoveLines :: (IsView a, MonadIO m) => a -> ViewMoveLinesCallback -> m SignalHandlerId Source #
onViewMoveLines :: (IsView a, MonadIO m) => a -> ViewMoveLinesCallback -> m SignalHandlerId Source #
wrap_ViewMoveLinesCallback :: ViewMoveLinesCallback -> Ptr () -> CInt -> Int32 -> Ptr () -> IO () Source #
moveToMatchingBracket
type ViewMoveToMatchingBracketCallback = Bool -> IO () Source #
afterViewMoveToMatchingBracket :: (IsView a, MonadIO m) => a -> ViewMoveToMatchingBracketCallback -> m SignalHandlerId Source #
mk_ViewMoveToMatchingBracketCallback :: C_ViewMoveToMatchingBracketCallback -> IO (FunPtr C_ViewMoveToMatchingBracketCallback) Source #
onViewMoveToMatchingBracket :: (IsView a, MonadIO m) => a -> ViewMoveToMatchingBracketCallback -> m SignalHandlerId Source #
wrap_ViewMoveToMatchingBracketCallback :: ViewMoveToMatchingBracketCallback -> Ptr () -> CInt -> Ptr () -> IO () Source #
moveWords
type ViewMoveWordsCallback = Int32 -> IO () Source #
afterViewMoveWords :: (IsView a, MonadIO m) => a -> ViewMoveWordsCallback -> m SignalHandlerId Source #
onViewMoveWords :: (IsView a, MonadIO m) => a -> ViewMoveWordsCallback -> m SignalHandlerId Source #
wrap_ViewMoveWordsCallback :: ViewMoveWordsCallback -> Ptr () -> Int32 -> Ptr () -> IO () Source #
redo
type ViewRedoCallback = IO () Source #
afterViewRedo :: (IsView a, MonadIO m) => a -> ViewRedoCallback -> m SignalHandlerId Source #
onViewRedo :: (IsView a, MonadIO m) => a -> ViewRedoCallback -> m SignalHandlerId Source #
wrap_ViewRedoCallback :: ViewRedoCallback -> Ptr () -> Ptr () -> IO () Source #
showCompletion
type ViewShowCompletionCallback = IO () Source #
afterViewShowCompletion :: (IsView a, MonadIO m) => a -> ViewShowCompletionCallback -> m SignalHandlerId Source #
mk_ViewShowCompletionCallback :: C_ViewShowCompletionCallback -> IO (FunPtr C_ViewShowCompletionCallback) Source #
onViewShowCompletion :: (IsView a, MonadIO m) => a -> ViewShowCompletionCallback -> m SignalHandlerId Source #
wrap_ViewShowCompletionCallback :: ViewShowCompletionCallback -> Ptr () -> Ptr () -> IO () Source #
smartHomeEnd
afterViewSmartHomeEnd :: (IsView a, MonadIO m) => a -> ViewSmartHomeEndCallback -> m SignalHandlerId Source #
mk_ViewSmartHomeEndCallback :: C_ViewSmartHomeEndCallback -> IO (FunPtr C_ViewSmartHomeEndCallback) Source #
onViewSmartHomeEnd :: (IsView a, MonadIO m) => a -> ViewSmartHomeEndCallback -> m SignalHandlerId Source #
wrap_ViewSmartHomeEndCallback :: ViewSmartHomeEndCallback -> Ptr () -> Ptr TextIter -> Int32 -> Ptr () -> IO () Source #
undo
type ViewUndoCallback = IO () Source #
afterViewUndo :: (IsView a, MonadIO m) => a -> ViewUndoCallback -> m SignalHandlerId Source #
onViewUndo :: (IsView a, MonadIO m) => a -> ViewUndoCallback -> m SignalHandlerId Source #
wrap_ViewUndoCallback :: ViewUndoCallback -> Ptr () -> Ptr () -> IO () Source #