no pattern grid pattern Feature: `v3_16` # Implements [`BufferExt`](trait.BufferExt.html), [`gtk::TextBufferExt`](../gtk/trait.TextBufferExt.html) Trait containing all `Buffer` methods. # Implementors [`Buffer`](struct.Buffer.html) Creates a new source buffer. ## `table` a `gtk::TextTagTable`, or `None` to create a new one. # Returns a new source buffer. Creates a new source buffer using the highlighting patterns in `language`. This is equivalent to creating a new source buffer with a new tag table and then calling `BufferExt::set_language`. ## `language` a `Language`. # Returns a new source buffer which will highlight text according to the highlighting patterns in `language`. Moves `iter` to the position of the previous `Mark` of the given category. Returns `true` if `iter` was moved. If `category` is NULL, the previous source mark can be of any category. ## `iter` an iterator. ## `category` category to search for, or `None` # Returns whether `iter` was moved. Marks the beginning of a not undoable action on the buffer, disabling the undo manager. Typically you would call this function before initially setting the contents of the buffer (e.g. when loading a file in a text editor). You may nest `BufferExt::begin_not_undoable_action` / `BufferExt::end_not_undoable_action` blocks. Determines whether a source buffer can redo the last action (i.e. if the last operation was an undo). # Returns `true` if a redo is possible. Determines whether a source buffer can undo the last action. # Returns `true` if it's possible to undo the last action. Changes the case of the text between the specified iterators. Feature: `v3_12` ## `case_type` how to change the case. ## `start` a `gtk::TextIter`. ## `end` a `gtk::TextIter`. Creates a source mark in the `self` of category `category`. A source mark is a `gtk::TextMark` but organised into categories. Depending on the category a pixbuf can be specified that will be displayed along the line of the mark. Like a `gtk::TextMark`, a `Mark` can be anonymous if the passed `name` is `None`. Also, the buffer owns the marks so you shouldn't unreference it. Marks always have left gravity and are moved to the beginning of the line when the user deletes the line they were in. Typical uses for a source mark are bookmarks, breakpoints, current executing instruction indication in a source file, etc.. ## `name` the name of the mark, or `None`. ## `category` a string defining the mark category. ## `where_` location to place the mark. # Returns a new `Mark`, owned by the buffer. In short, this is the same function as `gtk::TextBufferExt::create_tag`, but instead of creating a `gtk::TextTag`, this function creates a `Tag`. This function creates a `Tag` and adds it to the tag table for `self`. Equivalent to calling `gtk::TextTag::new` and then adding the tag to the buffer’s tag table. The returned tag is owned by the buffer’s tag table, so the ref count will be equal to one. If `tag_name` is `None`, the tag is anonymous. If `tag_name` is non-`None`, a tag called `tag_name` must not already exist in the tag table for this buffer. The `first_property_name` argument and subsequent arguments are a list of properties to set on the tag, as with `gobject::Object::set`. Feature: `v3_20` ## `tag_name` name of the new tag, or `None` ## `first_property_name` name of first property to set, or `None` # Returns a new `Tag`. Marks the end of a not undoable action on the buffer. When the last not undoable block is closed through the call to this function, the list of undo actions is cleared and the undo manager is re-enabled. Forces buffer to analyze and highlight the given area synchronously. `` `` This is a potentially slow operation and should be used only when you need to make sure that some text not currently visible is highlighted, for instance before printing. `` `` ## `start` start of the area to highlight. ## `end` end of the area to highlight. Moves `iter` to the position of the next `Mark` of the given `category`. Returns `true` if `iter` was moved. If `category` is NULL, the next source mark can be of any category. ## `iter` an iterator. ## `category` category to search for, or `None` # Returns whether `iter` was moved. Get all defined context classes at `iter`. See the `Buffer` description for the list of default context classes. ## `iter` a `gtk::TextIter`. # Returns a new `None` terminated array of context class names. Use `g_strfreev` to free the array if it is no longer needed. Determines whether bracket match highlighting is activated for the source buffer. # Returns `true` if the source buffer will highlight matching brackets. Determines whether syntax highlighting is activated in the source buffer. # Returns `true` if syntax highlighting is enabled, `false` otherwise. Feature: `v3_14` # Returns whether the `self` has an implicit trailing newline. Returns the `Language` associated with the buffer, see `BufferExt::set_language`. The returned object should not be unreferenced by the user. # Returns the `Language` associated with the buffer, or `None`. Determines the number of undo levels the buffer will track for buffer edits. # Returns the maximum number of possible undo levels or -1 if no limit is set. Returns the list of marks of the given category at `iter`. If `category` is `None` it returns all marks at `iter`. ## `iter` an iterator. ## `category` category to search for, or `None` # Returns a newly allocated `glib::SList`. Returns the list of marks of the given category at `line`. If `category` is `None`, all marks at `line` are returned. ## `line` a line number. ## `category` category to search for, or `None` # Returns a newly allocated `glib::SList`. Returns the `StyleScheme` associated with the buffer, see `BufferExt::set_style_scheme`. The returned object should not be unreferenced by the user. # Returns the `StyleScheme` associated with the buffer, or `None`. Returns the `UndoManager` associated with the buffer, see `BufferExt::set_undo_manager`. The returned object should not be unreferenced by the user. # Returns the `UndoManager` associated with the buffer, or `None`. Moves backward to the next toggle (on or off) of the context class. If no matching context class toggles are found, returns `false`, otherwise `true`. Does not return toggles located at `iter`, only toggles after `iter`. Sets `iter` to the location of the toggle, or to the end of the buffer if no toggle is found. See the `Buffer` description for the list of default context classes. ## `iter` a `gtk::TextIter`. ## `context_class` the context class. # Returns whether we found a context class toggle before `iter` Moves forward to the next toggle (on or off) of the context class. If no matching context class toggles are found, returns `false`, otherwise `true`. Does not return toggles located at `iter`, only toggles after `iter`. Sets `iter` to the location of the toggle, or to the end of the buffer if no toggle is found. See the `Buffer` description for the list of default context classes. ## `iter` a `gtk::TextIter`. ## `context_class` the context class. # Returns whether we found a context class toggle after `iter` Check if the class `context_class` is set on `iter`. See the `Buffer` description for the list of default context classes. ## `iter` a `gtk::TextIter`. ## `context_class` class to search for. # Returns whether `iter` has the context class. Joins the lines of text between the specified iterators. Feature: `v3_16` ## `start` a `gtk::TextIter`. ## `end` a `gtk::TextIter`. Redoes the last undo operation. Use `BufferExt::can_redo` to check whether a call to this function will have any effect. This function emits the `Buffer::redo` signal. Remove all marks of `category` between `start` and `end` from the buffer. If `category` is NULL, all marks in the range will be removed. ## `start` a `gtk::TextIter`. ## `end` a `gtk::TextIter`. ## `category` category to search for, or `None`. Controls the bracket match highlighting function in the buffer. If activated, when you position your cursor over a bracket character (a parenthesis, a square bracket, etc.) the matching opening or closing bracket character will be highlighted. ## `highlight` `true` if you want matching brackets highlighted. Controls whether syntax is highlighted in the buffer. If `highlight` is `true`, the text will be highlighted according to the syntax patterns specified in the `Language` set with `BufferExt::set_language`. If `highlight` is `false`, syntax highlighting is disabled and all the `gtk::TextTag` objects that have been added by the syntax highlighting engine are removed from the buffer. ## `highlight` `true` to enable syntax highlighting, `false` to disable it. Sets whether the `self` has an implicit trailing newline. If an explicit trailing newline is present in a `gtk::TextBuffer`, `gtk::TextView` shows it as an empty line. This is generally not what the user expects. If `implicit_trailing_newline` is `true` (the default value): - when a `FileLoader` loads the content of a file into the `self`, the trailing newline (if present in the file) is not inserted into the `self`. - when a `FileSaver` saves the content of the `self` into a file, a trailing newline is added to the file. On the other hand, if `implicit_trailing_newline` is `false`, the file's content is not modified when loaded into the `self`, and the `self`'s content is not modified when saved into a file. Feature: `v3_14` ## `implicit_trailing_newline` the new value. Associates a `Language` with the buffer. Note that a `Language` affects not only the syntax highlighting, but also the [context classes][context-classes]. If you want to disable just the syntax highlighting, see `BufferExt::set_highlight_syntax`. The buffer holds a reference to `language`. ## `language` a `Language` to set, or `None`. Sets the number of undo levels for user actions the buffer will track. If the number of user actions exceeds the limit set by this function, older actions will be discarded. If `max_undo_levels` is -1, the undo/redo is unlimited. If `max_undo_levels` is 0, the undo/redo is disabled. ## `max_undo_levels` the desired maximum number of undo levels. Sets a `StyleScheme` to be used by the buffer and the view. Note that a `StyleScheme` affects not only the syntax highlighting, but also other `View` features such as highlighting the current line, matching brackets, the line numbers, etc. Instead of setting a `None` `scheme`, it is better to disable syntax highlighting with `BufferExt::set_highlight_syntax`, and setting the `StyleScheme` with the "classic" or "tango" ID, because those two style schemes follow more closely the GTK+ theme (for example for the background color). The buffer holds a reference to `scheme`. ## `scheme` a `StyleScheme` or `None`. Set the buffer undo manager. If `manager` is `None` the default undo manager will be set. ## `manager` A `UndoManager` or `None`. Sort the lines of text between the specified iterators. Feature: `v3_18` ## `start` a `gtk::TextIter`. ## `end` a `gtk::TextIter`. ## `flags` `SortFlags` specifying how the sort should behave ## `column` sort considering the text starting at the given column Undoes the last user action which modified the buffer. Use `BufferExt::can_undo` to check whether a call to this function will have any effect. This function emits the `Buffer::undo` signal. `iter` is set to a valid iterator pointing to the matching bracket if `state` is `BracketMatchType::Found`. Otherwise `iter` is meaningless. The signal is emitted only when the `state` changes, typically when the cursor moves. A use-case for this signal is to show messages in a `gtk::Statusbar`. ## `iter` if found, the location of the matching bracket. ## `state` state of bracket matching. The ::highlight-updated signal is emitted when the syntax highlighting and [context classes][context-classes] are updated in a certain region of the `buffer`. ## `start` the start of the updated region ## `end` the end of the updated region The ::redo signal is emitted to redo the last undo operation. The ::source-mark-updated signal is emitted each time a mark is added to, moved or removed from the `buffer`. ## `mark` the `Mark` The ::undo signal is emitted to undo the last user action which modified the buffer. Whether to highlight matching brackets in the buffer. Whether to highlight matching brackets in the buffer. Whether to highlight syntax in the buffer. Whether to highlight syntax in the buffer. Whether the buffer has an implicit trailing newline. See `BufferExt::set_implicit_trailing_newline`. Feature: `v3_14` Whether the buffer has an implicit trailing newline. See `BufferExt::set_implicit_trailing_newline`. Feature: `v3_14` Number of undo levels for the buffer. -1 means no limit. This property will only affect the default undo manager. Number of undo levels for the buffer. -1 means no limit. This property will only affect the default undo manager. Style scheme. It contains styles for syntax highlighting, optionally foreground, background, cursor color, current line color, and matching brackets style. Style scheme. It contains styles for syntax highlighting, optionally foreground, background, cursor color, current line color, and matching brackets style. change case to lowercase. change case to uppercase. toggle case of each character. capitalize each word. Feature: `v3_12` # Implements [`CompletionExt`](trait.CompletionExt.html), [`gtk::BuildableExt`](../gtk/trait.BuildableExt.html) Trait containing all `Completion` methods. # Implementors [`Completion`](struct.Completion.html) Add a new `CompletionProvider` to the completion object. This will add a reference `provider`, so make sure to unref your own copy when you no longer need it. ## `provider` a `CompletionProvider`. # Returns `true` if `provider` was successfully added, otherwise if `error` is provided, it will be set with the error and `false` is returned. Block interactive completion. This can be used to disable interactive completion when inserting or deleting text from the buffer associated with the completion. Use `CompletionExt::unblock_interactive` to enable interactive completion again. This function may be called multiple times. It will continue to block interactive completion until `CompletionExt::unblock_interactive` has been called the same number of times. Create a new `CompletionContext` for `self`. The position where the completion occurs can be specified by `position`. If `position` is `None`, the current cursor position will be used. ## `position` a `gtk::TextIter`, or `None`. # Returns a new `CompletionContext`. The reference being returned is a 'floating' reference, so if you invoke `CompletionExt::show` with this context you don't need to unref it. The info widget is the window where the completion displays optional extra information of the proposal. # Returns The `CompletionInfo` window associated with `self`. Get list of providers registered on `self`. The returned list is owned by the completion and should not be freed. # Returns list of `CompletionProvider`. The `View` associated with `self`, or `None` if the view has been destroyed. # Returns The `View` associated with `self`, or `None`. Hides the completion if it is active (visible). Move the completion window to a specific iter. # Deprecated since 3.8 Use `CompletionProvider::get_start_iter` instead. ## `iter` a `gtk::TextIter`. Remove `provider` from the completion. ## `provider` a `CompletionProvider`. # Returns `true` if `provider` was successfully removed, otherwise if `error` is provided, it will be set with the error and `false` is returned. Starts a new completion with the specified `CompletionContext` and a list of potential candidate providers for completion. It can be convenient for showing a completion on-the-fly, without the need to add or remove providers to the `Completion`. Another solution is to add providers with `CompletionExt::add_provider`, and implement `CompletionProvider::match` for each provider. ## `providers` a list of `CompletionProvider`, or `None`. ## `context` The `CompletionContext` with which to start the completion. # Returns `true` if it was possible to the show completion window. Unblock interactive completion. This can be used after using `CompletionExt::block_interactive` to enable interactive completion again. The `Completion::activate-proposal` signal is a keybinding signal which gets emitted when the user initiates a proposal activation. Applications should not connect to it, but may emit it with `g_signal_emit_by_name` if they need to control the proposal activation programmatically. Emitted when the completion window is hidden. The default handler will actually hide the window. The `Completion::move-cursor` signal is a keybinding signal which gets emitted when the user initiates a cursor movement. The ``Up``, ``Down``, ``PageUp``, ``PageDown``, ``Home`` and ``End`` keys are bound to the normal behavior expected by those keys. When `step` is equal to `gtk::ScrollStep::Pages`, the page size is defined by the `Completion:proposal-page-size` property. It is used for the ``PageDown`` and ``PageUp`` keys. Applications should not connect to it, but may emit it with `g_signal_emit_by_name` if they need to control the cursor programmatically. ## `step` The `gtk::ScrollStep` by which to move the cursor ## `num` The amount of steps to move the cursor The `Completion::move-page` signal is a keybinding signal which gets emitted when the user initiates a page movement (i.e. switches between provider pages). ````Control````Left```` is for going to the previous provider. ````Control````Right```` is for going to the next provider. ````Control````Home```` is for displaying all the providers. ````Control````End```` is for going to the last provider. When `step` is equal to `gtk::ScrollStep::Pages`, the page size is defined by the `Completion:provider-page-size` property. Applications should not connect to it, but may emit it with `g_signal_emit_by_name` if they need to control the page selection programmatically. ## `step` The `gtk::ScrollStep` by which to move the page ## `num` The amount of steps to move the page Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context. ## `context` The `CompletionContext` for the current completion Emitted when the completion window is shown. The default handler will actually show the window. Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press ````Alt````1````. Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press ````Alt````1````. Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion. Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion. The scroll page size of the proposals in the completion window. In other words, when ``PageDown`` or ``PageUp`` is pressed, the selected proposal becomes the one which is located one page size backward or forward. See also the `Completion::move-cursor` signal. The scroll page size of the proposals in the completion window. In other words, when ``PageDown`` or ``PageUp`` is pressed, the selected proposal becomes the one which is located one page size backward or forward. See also the `Completion::move-cursor` signal. The scroll page size of the provider pages in the completion window. See the `Completion::move-page` signal. The scroll page size of the provider pages in the completion window. See the `Completion::move-page` signal. Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again. Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again. Determines whether the first proposal should be selected when the completion is first shown. Determines whether the first proposal should be selected when the completion is first shown. Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider. Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider. Determines whether provider and proposal icons should be shown in the completion popup. Determines whether provider and proposal icons should be shown in the completion popup. The `View` bound to the completion object. The `View` bound to the completion object. # Implements [`CompletionContextExt`](trait.CompletionContextExt.html) Trait containing all `CompletionContext` methods. # Implementors [`CompletionContext`](struct.CompletionContext.html) Providers can use this function to add proposals to the completion. They can do so asynchronously by means of the `finished` argument. Providers must ensure that they always call this function with `finished` set to `true` once each population (even if no proposals need to be added). Population occurs when the `CompletionProvider::populate` function is called. ## `provider` a `CompletionProvider`. ## `proposals` The list of proposals to add. ## `finished` Whether the provider is finished adding proposals. Get the context activation. # Returns The context activation. Get the iter at which the completion was invoked. Providers can use this to determine how and if to match proposals. ## `iter` a `gtk::TextIter`. # Returns `true` if `iter` is correctly set, `false` otherwise. Emitted when the current population of proposals has been cancelled. Providers adding proposals asynchronously should connect to this signal to know when to cancel running proposal queries. The completion activation The completion activation The `Completion` associated with the context. The `Completion` associated with the context. The `gtk::TextIter` at which the completion is invoked. The `gtk::TextIter` at which the completion is invoked. # Implements [`CompletionInfoExt`](trait.CompletionInfoExt.html), [`gtk::WindowExt`](../gtk/trait.WindowExt.html), [`gtk::BinExt`](../gtk/trait.BinExt.html), [`gtk::ContainerExt`](../gtk/trait.ContainerExt.html), [`gtk::WidgetExt`](../gtk/trait.WidgetExt.html), [`gtk::BuildableExt`](../gtk/trait.BuildableExt.html) Trait containing all `CompletionInfo` methods. # Implementors [`CompletionInfo`](struct.CompletionInfo.html) # Returns a new `CompletionInfo`. Get the current content widget. # Deprecated since 3.8 Use `gtk::BinExt::get_child` instead. # Returns The current content widget. Moves the `CompletionInfo` to `iter`. If `iter` is `None` `self` is moved to the cursor position. Moving will respect the `gdk::Gravity` setting of the info window and will ensure the line at `iter` is not occluded by the window. ## `view` a `gtk::TextView` on which the info window should be positioned. ## `iter` a `gtk::TextIter`. Sets the content widget of the info window. See that the previous widget will lose a reference and it can be destroyed, so if you do not want this to happen you must use `gobject::Object::ref` before calling this method. # Deprecated since 3.8 Use `gtk::ContainerExt::add` instead. If there is already a child widget, remove it with `gtk::ContainerExt::remove`. ## `widget` a `gtk::Widget`. This signal is emitted before any "show" management. You can connect to this signal if you want to change some properties or position before the real "show". # Deprecated since 3.10 This signal should not be used. # Implements [`CompletionItemExt`](trait.CompletionItemExt.html), [`CompletionProposalExt`](trait.CompletionProposalExt.html) Trait containing all `CompletionItem` methods. # Implementors [`CompletionItem`](struct.CompletionItem.html) Create a new `CompletionItem` with label `label`, icon `icon` and extra information `info`. Both `icon` and `info` can be `None` in which case there will be no icon shown and no extra information available. # Deprecated since 3.24 Use `CompletionItem::new2` instead. ## `label` The item label. ## `text` The item text. ## `icon` The item icon. ## `info` The item extra information. # Returns a new `CompletionItem`. Creates a new `CompletionItem` from a stock item. If `label` is `None`, the stock label will be used. # Deprecated since 3.10 Use `CompletionItem::new2` instead. ## `label` The item label. ## `text` The item text. ## `stock` The stock icon. ## `info` The item extra information. # Returns a new `CompletionItem`. Create a new `CompletionItem` with markup label `markup`, icon `icon` and extra information `info`. Both `icon` and `info` can be `None` in which case there will be no icon shown and no extra information available. # Deprecated since 3.24 Use `CompletionItem::new2` instead. ## `markup` The item markup label. ## `text` The item text. ## `icon` The item icon. ## `info` The item extra information. # Returns a new `CompletionItem`. Creates a new `CompletionItem`. The desired properties need to be set afterwards. Feature: `v3_24` # Returns a new `CompletionItem`. Feature: `v3_24` ## `gicon` the `gio::Icon`, or `None`. Feature: `v3_24` ## `icon` the `gdk_pixbuf::Pixbuf`, or `None`. Feature: `v3_24` ## `icon_name` the icon name, or `None`. Feature: `v3_24` ## `info` the info, or `None`. Feature: `v3_24` ## `label` the label, or `None`. Feature: `v3_24` ## `markup` the markup, or `None`. Feature: `v3_24` ## `text` the text, or `None`. The `gio::Icon` for the icon to be shown for this proposal. Feature: `v3_18` The `gio::Icon` for the icon to be shown for this proposal. Feature: `v3_18` The `gdk_pixbuf::Pixbuf` for the icon to be shown for this proposal. The `gdk_pixbuf::Pixbuf` for the icon to be shown for this proposal. The icon name for the icon to be shown for this proposal. Feature: `v3_18` The icon name for the icon to be shown for this proposal. Feature: `v3_18` Optional extra information to be shown for this proposal. Optional extra information to be shown for this proposal. Label to be shown for this proposal. Label to be shown for this proposal. Label with markup to be shown for this proposal. Label with markup to be shown for this proposal. Proposal text. Proposal text. # Implements [`CompletionProposalExt`](trait.CompletionProposalExt.html) Trait containing all `CompletionProposal` methods. # Implementors [`CompletionItem`](struct.CompletionItem.html), [`CompletionProposal`](struct.CompletionProposal.html) Emits the "changed" signal on `self`. This should be called by implementations whenever the name, icon or info of the proposal has changed. Get whether two proposal objects are the same. This is used to (together with `CompletionProposal::hash`) to match proposals in the completion model. By default, it uses direct equality (`g_direct_equal`). ## `other` a `CompletionProposal`. # Returns `true` if `self` and `object` are the same proposal Gets the `gio::Icon` for the icon of `self`. Feature: `v3_18` # Returns A `gio::Icon` with the icon of `self`. Gets the `gdk_pixbuf::Pixbuf` for the icon of `self`. # Returns A `gdk_pixbuf::Pixbuf` with the icon of `self`. Gets the icon name of `self`. Feature: `v3_18` # Returns The icon name of `self`. Gets extra information associated to the proposal. This information will be used to present the user with extra, detailed information about the selected proposal. The returned string must be freed with `g_free`. # Returns a newly-allocated string containing extra information of `self` or `None` if no extra information is associated to `self`. Gets the label of `self`. The label is shown in the list of proposals as plain text. If you need any markup (such as bold or italic text), you have to implement `CompletionProposal::get_markup`. The returned string must be freed with `g_free`. # Returns a new string containing the label of `self`. Gets the label of `self` with markup. The label is shown in the list of proposals and may contain markup. This will be used instead of `CompletionProposal::get_label` if implemented. The returned string must be freed with `g_free`. # Returns a new string containing the label of `self` with markup. Gets the text of `self`. The text that is inserted into the text buffer when the proposal is activated by the default activation. You are free to implement a custom activation handler in the provider and not implement this function. For more information, see `CompletionProvider::activate_proposal`. The returned string must be freed with `g_free`. # Returns a new string containing the text of `self`. Get the hash value of `self`. This is used to (together with `CompletionProposal::equal`) to match proposals in the completion model. By default, it uses a direct hash (`g_direct_hash`). # Returns The hash value of `self`. Emitted when the proposal has changed. The completion popup will react to this by updating the shown information. # Implements [`CompletionProviderExt`](trait.CompletionProviderExt.html) Trait containing all `CompletionProvider` methods. # Implementors [`CompletionProvider`](struct.CompletionProvider.html), [`CompletionWords`](struct.CompletionWords.html) Activate `proposal` at `iter`. When this functions returns `false`, the default activation of `proposal` will take place which replaces the word at `iter` with the text of `proposal` (see `CompletionProposal::get_text`). Here is how the default activation selects the boundaries of the word to replace. The end of the word is `iter`. For the start of the word, it depends on whether a start iter is defined for `proposal` (see `CompletionProvider::get_start_iter`). If a start iter is defined, the start of the word is the start iter. Else, the word (as long as possible) will contain only alphanumerical and the "_" characters. ## `proposal` a `CompletionProposal`. ## `iter` a `gtk::TextIter`. # Returns `true` to indicate that the proposal activation has been handled, `false` otherwise. Get with what kind of activation the provider should be activated. # Returns a combination of `CompletionActivation`. Gets the `gio::Icon` for the icon of `self`. Feature: `v3_18` # Returns The icon to be used for the provider, or `None` if the provider does not have a special icon. Get the `gdk_pixbuf::Pixbuf` for the icon of the `self`. # Returns The icon to be used for the provider, or `None` if the provider does not have a special icon. Gets the icon name of `self`. Feature: `v3_18` # Returns The icon name to be used for the provider, or `None` if the provider does not have a special icon. Get a customized info widget to show extra information of a proposal. This allows for customized widgets on a proposal basis, although in general providers will have the same custom widget for all their proposals and `proposal` can be ignored. The implementation of this function is optional. If this function is not implemented, the default widget is a `gtk::Label`. The return value of `CompletionProposal::get_info` is used as the content of the `gtk::Label`. `` `` If implemented, `CompletionProvider::update_info` ``must`` also be implemented. `` `` ## `proposal` a currently selected `CompletionProposal`. # Returns a custom `gtk::Widget` to show extra information about `proposal`, or `None` if the provider does not have a special info widget. Get the delay in milliseconds before starting interactive completion for this provider. A value of -1 indicates to use the default value as set by the `Completion:auto-complete-delay` property. # Returns the interactive delay in milliseconds. Get the name of the provider. This should be a translatable name for display to the user. For example: _("Document word completion provider"). The returned string must be freed with `g_free`. # Returns a new string containing the name of the provider. Get the provider priority. The priority determines the order in which proposals appear in the completion popup. Higher priorities are sorted before lower priorities. The default priority is 0. # Returns the provider priority. Get the `gtk::TextIter` at which the completion for `proposal` starts. When implemented, this information is used to position the completion window accordingly when a proposal is selected in the completion window. The `proposal` text inside the completion window is aligned on `iter`. If this function is not implemented, the word boundary is taken to position the completion window. See `CompletionProvider::activate_proposal` for an explanation on the word boundaries. When the `proposal` is activated, the default handler uses `iter` as the start of the word to replace. See `CompletionProvider::activate_proposal` for more information. ## `context` a `CompletionContext`. ## `proposal` a `CompletionProposal`. ## `iter` a `gtk::TextIter`. # Returns `true` if `iter` was set for `proposal`, `false` otherwise. Get whether the provider match the context of completion detailed in `context`. ## `context` a `CompletionContext`. # Returns `true` if `self` matches the completion context, `false` otherwise. Populate `context` with proposals from `self` added with the `CompletionContextExt::add_proposals` function. ## `context` a `CompletionContext`. Update extra information shown in `info` for `proposal`. `` `` This function ``must`` be implemented when `CompletionProvider::get_info_widget` is implemented. `` `` ## `proposal` a `CompletionProposal`. ## `info` a `CompletionInfo`. # Implements [`CompletionWordsExt`](trait.CompletionWordsExt.html), [`CompletionProviderExt`](trait.CompletionProviderExt.html) Trait containing all `CompletionWords` methods. # Implementors [`CompletionWords`](struct.CompletionWords.html) ## `name` The name for the provider, or `None`. ## `icon` A specific icon for the provider, or `None`. # Returns a new `CompletionWords` provider Registers `buffer` in the `self` provider. ## `buffer` a `gtk::TextBuffer` Unregisters `buffer` from the `self` provider. ## `buffer` a `gtk::TextBuffer` The type of activation. Feature: `v3_10` The type of activation. Feature: `v3_10` plain text. gzip compression. Feature: `v3_14` Feature: `v3_14` Used by language bindings. Feature: `v3_14` # Returns a copy of `self`. Used by language bindings. Feature: `v3_14` Gets the character set of the `Encoding`, such as "UTF-8" or "ISO-8859-1". Feature: `v3_14` # Returns the character set of the `Encoding`. Gets the name of the `Encoding` such as "Unicode" or "Western". Feature: `v3_14` # Returns the name of the `Encoding`. Feature: `v3_14` # Returns a string representation. Free with `g_free` when no longer needed. Gets all encodings. Feature: `v3_14` # Returns a list of all `Encoding`'s. Free with `glib::SList::free`. Gets the `Encoding` for the current locale. See also `g_get_charset`. Feature: `v3_14` # Returns the current locale encoding. Gets the list of default candidate encodings to try when loading a file. See `FileLoader::set_candidate_encodings`. This function returns a different list depending on the current locale (i.e. language, country and default encoding). The UTF-8 encoding and the current locale encoding are guaranteed to be present in the returned list. Feature: `v3_18` # Returns the list of default candidate encodings. Free with `glib::SList::free`. Gets a `Encoding` from a character set such as "UTF-8" or "ISO-8859-1". Feature: `v3_14` ## `charset` a character set. # Returns the corresponding `Encoding`, or `None` if not found. Feature: `v3_14` # Returns the UTF-8 encoding. Feature: `v3_14` # Implements [`FileExt`](trait.FileExt.html) Trait containing all `File` methods. Feature: `v3_14` # Implementors [`File`](struct.File.html) Feature: `v3_14` # Returns a new `File` object. Checks synchronously the file on disk, to know whether the file is externally modified, or has been deleted, and whether the file is read-only. `File` doesn't create a `gio::FileMonitor` to track those properties, so this function needs to be called instead. Creating lots of `gio::FileMonitor`'s would take lots of resources. Since this function is synchronous, it is advised to call it only on local files. See `FileExt::is_local`. Feature: `v3_18` Feature: `v3_14` # Returns the compression type. The encoding is initially `None`. After a successful file loading or saving operation, the encoding is non-`None`. Feature: `v3_14` # Returns the character encoding. Feature: `v3_14` # Returns the `gio::File`. Feature: `v3_14` # Returns the newline type. Returns whether the file has been deleted. If the `File:location` is `None`, returns `false`. To have an up-to-date value, you must first call `FileExt::check_file_on_disk`. Feature: `v3_18` # Returns whether the file has been deleted. Returns whether the file is externally modified. If the `File:location` is `None`, returns `false`. To have an up-to-date value, you must first call `FileExt::check_file_on_disk`. Feature: `v3_18` # Returns whether the file is externally modified. Returns whether the file is local. If the `File:location` is `None`, returns `false`. Feature: `v3_18` # Returns whether the file is local. Returns whether the file is read-only. If the `File:location` is `None`, returns `false`. To have an up-to-date value, you must first call `FileExt::check_file_on_disk`. Feature: `v3_18` # Returns whether the file is read-only. Sets the location. Feature: `v3_14` ## `location` the new `gio::File`, or `None`. Sets a ``GtkSourceMountOperationFactory`` function that will be called when a `gio::MountOperation` must be created. This is useful for creating a `gtk::MountOperation` with the parent `gtk::Window`. If a mount operation factory isn't set, `gio::MountOperation::new` will be called. Feature: `v3_14` ## `callback` a ``GtkSourceMountOperationFactory`` to call when a `gio::MountOperation` is needed. ## `user_data` the data to pass to the `callback` function. ## `notify` function to call on `user_data` when the `callback` is no longer needed, or `None`. The compression type. Feature: `v3_14` The character encoding, initially `None`. After a successful file loading or saving operation, the encoding is non-`None`. Feature: `v3_14` The location. Feature: `v3_14` The location. Feature: `v3_14` The line ending type. Feature: `v3_14` Whether the file is read-only or not. The value of this property is not updated automatically (there is no file monitors). Feature: `v3_18` Feature: `v3_14` # Implements [`FileLoaderExt`](trait.FileLoaderExt.html) Trait containing all `FileLoader` methods. Feature: `v3_14` # Implementors [`FileLoader`](struct.FileLoader.html) Creates a new `FileLoader` object. The contents is read from the `File`'s location. If not already done, call `FileExt::set_location` before calling this constructor. The previous location is anyway not needed, because as soon as the file loading begins, the `buffer` is emptied. Feature: `v3_14` ## `buffer` the `Buffer` to load the contents into. ## `file` the `File`. # Returns a new `FileLoader` object. Creates a new `FileLoader` object. The contents is read from `stream`. Feature: `v3_14` ## `buffer` the `Buffer` to load the contents into. ## `file` the `File`. ## `stream` the `gio::InputStream` to load, e.g. stdin. # Returns a new `FileLoader` object. Feature: `v3_14` # Returns the `Buffer` to load the contents into. Feature: `v3_14` # Returns the detected compression type. Feature: `v3_14` # Returns the detected file encoding. Feature: `v3_14` # Returns the `File`. Feature: `v3_14` # Returns the `gio::InputStream` to load, or `None` if a `gio::File` is used. Feature: `v3_14` # Returns the `gio::File` to load, or `None` if an input stream is used. Feature: `v3_14` # Returns the detected newline type. Loads asynchronously the file or input stream contents into the `Buffer`. See the `gio::AsyncResult` documentation to know how to use this function. Feature: `v3_14` ## `io_priority` the I/O priority of the request. E.g. `G_PRIORITY_LOW`, `G_PRIORITY_DEFAULT` or `G_PRIORITY_HIGH`. ## `cancellable` optional `gio::Cancellable` object, `None` to ignore. ## `progress_callback` function to call back with progress information, or `None` if progress information is not needed. ## `progress_callback_data` user data to pass to `progress_callback`. ## `progress_callback_notify` function to call on `progress_callback_data` when the `progress_callback` is no longer needed, or `None`. ## `callback` a `GAsyncReadyCallback` to call when the request is satisfied. ## `user_data` user data to pass to `callback`. Finishes a file loading started with `FileLoaderExt::load_async`. If the contents has been loaded, the following `File` properties will be updated: the location, the encoding, the newline type and the compression type. Feature: `v3_14` ## `result` a `gio::AsyncResult`. # Returns whether the contents has been loaded successfully. Sets the candidate encodings for the file loading. The encodings are tried in the same order as the list. For convenience, `candidate_encodings` can contain duplicates. Only the first occurrence of a duplicated encoding is kept in the list. By default the candidate encodings are (in that order in the list): 1. If set, the `File`'s encoding as returned by `FileExt::get_encoding`. 2. The default candidates as returned by `Encoding::get_default_candidates`. Feature: `v3_14` ## `candidate_encodings` a list of `Encoding`s. The `Buffer` to load the contents into. The `FileLoader` object has a weak reference to the buffer. Feature: `v3_14` The `Buffer` to load the contents into. The `FileLoader` object has a weak reference to the buffer. Feature: `v3_14` The `File`. The `FileLoader` object has a weak reference to the file. Feature: `v3_14` The `File`. The `FileLoader` object has a weak reference to the file. Feature: `v3_14` The `gio::InputStream` to load. Useful for reading stdin. If this property is set, the `FileLoader:location` property is ignored. Feature: `v3_14` The `gio::InputStream` to load. Useful for reading stdin. If this property is set, the `FileLoader:location` property is ignored. Feature: `v3_14` The `gio::File` to load. If the `FileLoader:input-stream` is `None`, by default the location is taken from the `File` at construction time. Feature: `v3_14` The `gio::File` to load. If the `FileLoader:input-stream` is `None`, by default the location is taken from the `File` at construction time. Feature: `v3_14` Feature: `v3_14` # Implements [`FileSaverExt`](trait.FileSaverExt.html) Trait containing all `FileSaver` methods. Feature: `v3_14` # Implementors [`FileSaver`](struct.FileSaver.html) Creates a new `FileSaver` object. The `buffer` will be saved to the `File`'s location. This constructor is suitable for a simple "save" operation, when the `file` already contains a non-`None` `File:location`. Feature: `v3_14` ## `buffer` the `Buffer` to save. ## `file` the `File`. # Returns a new `FileSaver` object. Creates a new `FileSaver` object with a target location. When the file saving is finished successfully, `target_location` is set to the `file`'s `File:location` property. If an error occurs, the previous valid location is still available in `File`. This constructor is suitable for a "save as" operation, or for saving a new buffer for the first time. Feature: `v3_14` ## `buffer` the `Buffer` to save. ## `file` the `File`. ## `target_location` the `gio::File` where to save the buffer to. # Returns a new `FileSaver` object. Feature: `v3_14` # Returns the `Buffer` to save. Feature: `v3_14` # Returns the compression type. Feature: `v3_14` # Returns the encoding. Feature: `v3_14` # Returns the `File`. Feature: `v3_14` # Returns the flags. Feature: `v3_14` # Returns the `gio::File` where to save the buffer to. Feature: `v3_14` # Returns the newline type. Saves asynchronously the buffer into the file. See the `gio::AsyncResult` documentation to know how to use this function. Feature: `v3_14` ## `io_priority` the I/O priority of the request. E.g. `G_PRIORITY_LOW`, `G_PRIORITY_DEFAULT` or `G_PRIORITY_HIGH`. ## `cancellable` optional `gio::Cancellable` object, `None` to ignore. ## `progress_callback` function to call back with progress information, or `None` if progress information is not needed. ## `progress_callback_data` user data to pass to `progress_callback`. ## `progress_callback_notify` function to call on `progress_callback_data` when the `progress_callback` is no longer needed, or `None`. ## `callback` a `GAsyncReadyCallback` to call when the request is satisfied. ## `user_data` user data to pass to `callback`. Finishes a file saving started with `FileSaverExt::save_async`. If the file has been saved successfully, the following `File` properties will be updated: the location, the encoding, the newline type and the compression type. Since the 3.20 version, `gtk::TextBufferExt::set_modified` is called with `false` if the file has been saved successfully. Feature: `v3_14` ## `result` a `gio::AsyncResult`. # Returns whether the file was saved successfully. Sets the compression type. By default the compression type is taken from the `File`. Feature: `v3_14` ## `compression_type` the new compression type. Sets the encoding. If `encoding` is `None`, the UTF-8 encoding will be set. By default the encoding is taken from the `File`. Feature: `v3_14` ## `encoding` the new encoding, or `None` for UTF-8. Feature: `v3_14` ## `flags` the new flags. Sets the newline type. By default the newline type is taken from the `File`. Feature: `v3_14` ## `newline_type` the new newline type. The `Buffer` to save. The `FileSaver` object has a weak reference to the buffer. Feature: `v3_14` The `Buffer` to save. The `FileSaver` object has a weak reference to the buffer. Feature: `v3_14` The compression type. Feature: `v3_14` The compression type. Feature: `v3_14` The file's encoding. Feature: `v3_14` The file's encoding. Feature: `v3_14` The `File`. The `FileSaver` object has a weak reference to the file. Feature: `v3_14` The `File`. The `FileSaver` object has a weak reference to the file. Feature: `v3_14` File saving flags. Feature: `v3_14` File saving flags. Feature: `v3_14` The `gio::File` where to save the buffer. By default the location is taken from the `File` at construction time. Feature: `v3_14` The `gio::File` where to save the buffer. By default the location is taken from the `File` at construction time. Feature: `v3_14` The newline type. Feature: `v3_14` The newline type. Feature: `v3_14` # Implements [`GutterExt`](trait.GutterExt.html) Trait containing all `Gutter` methods. # Implementors [`Gutter`](struct.Gutter.html) # Deprecated since 3.12 Use `GutterRendererExt::get_padding` instead. Finds the `GutterRenderer` at (x, y). ## `x` The x position to get identified. ## `y` The y position to get identified. # Returns the renderer at (x, y) or `None`. Feature: `v3_24` # Returns the associated `View`. Get the `gdk::Window` of the gutter. The window will only be available when the gutter has at least one, non-zero width, cell renderer packed. # Deprecated since 3.12 Use `gtk::TextViewExt::get_window` instead. # Returns the `gdk::Window` of the gutter, or `None` if the gutter has no window. Feature: `v3_24` # Returns the `gtk::TextWindowType` of `self`. Insert `renderer` into the gutter. If `renderer` is yet unowned then gutter claims its ownership. Otherwise just increases renderer's reference count. `renderer` cannot be already inserted to another gutter. ## `renderer` a gutter renderer (must inherit from `GutterRenderer`). ## `position` the renderer position. # Returns `true` if operation succeeded. Otherwise `false`. Invalidates the drawable area of the gutter. You can use this to force a redraw of the gutter if something has changed and needs to be redrawn. Removes `renderer` from `self`. ## `renderer` a `GutterRenderer`. Reorders `renderer` in `self` to new `position`. ## `renderer` a `gtk::CellRenderer`. ## `position` the new renderer position. # Deprecated since 3.12 Use `GutterRendererExt::set_padding` instead. The `View` of the gutter. The `View` of the gutter. The text window type on which the window is placed. The text window type on which the window is placed. The x-padding. # Deprecated since 3.12 Use the `GutterRenderer`'s `GutterRenderer:xpad` property instead. The x-padding. # Deprecated since 3.12 Use the `GutterRenderer`'s `GutterRenderer:xpad` property instead. The y-padding. # Deprecated since 3.12 Use the `GutterRenderer`'s `GutterRenderer:ypad` property instead. The y-padding. # Deprecated since 3.12 Use the `GutterRenderer`'s `GutterRenderer:ypad` property instead. # Implements [`GutterRendererExt`](trait.GutterRendererExt.html) Trait containing all `GutterRenderer` methods. # Implementors [`GutterRendererPixbuf`](struct.GutterRendererPixbuf.html), [`GutterRendererText`](struct.GutterRendererText.html), [`GutterRenderer`](struct.GutterRenderer.html) Emits the `GutterRenderer::activate` signal of the renderer. This is called from `Gutter` and should never have to be called manually. ## `iter` a `gtk::TextIter` at the start of the line where the renderer is activated ## `area` a `gdk::Rectangle` of the cell area where the renderer is activated ## `event` the event that triggered the activation Called when drawing a region begins. The region to be drawn is indicated by `start` and `end`. The purpose is to allow the implementation to precompute some state before the draw method is called for each cell. ## `cr` a `cairo::Context` ## `background_area` a `gdk::Rectangle` ## `cell_area` a `gdk::Rectangle` ## `start` a `gtk::TextIter` ## `end` a `gtk::TextIter` Main renderering method. Implementations should implement this method to draw onto the cairo context. The `background_area` indicates the total area of the cell to be drawn. The `cell_area` indicates the area where content can be drawn (text, images, etc). The `background_area` is the `cell_area` plus the padding on each side (two times the `GutterRenderer:xpad` horizontally and two times the `GutterRenderer:ypad` vertically, so that the `cell_area` is centered inside `background_area`). The `state` argument indicates the current state of the renderer and should be taken into account to properly draw the different possible states (cursor, prelit, selected) if appropriate. ## `cr` the cairo render context ## `background_area` a `gdk::Rectangle` indicating the total area to be drawn ## `cell_area` a `gdk::Rectangle` indicating the area to draw content ## `start` a `gtk::TextIter` ## `end` a `gtk::TextIter` ## `state` a `GutterRendererState` Called when drawing a region of lines has ended. Get the x-alignment and y-alignment of the gutter renderer. ## `xalign` return location for the x-alignment, or `None` to ignore. ## `yalign` return location for the y-alignment, or `None` to ignore. Get the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign). # Returns a `GutterRendererAlignmentMode` Get the background color of the renderer. ## `color` return value for a `gdk::RGBA` # Returns `true` if the background color is set, `false` otherwise Get the x-padding and y-padding of the gutter renderer. ## `xpad` return location for the x-padding, or `None` to ignore. ## `ypad` return location for the y-padding, or `None` to ignore. Get the size of the renderer. # Returns the size of the renderer. Get the view associated to the gutter renderer # Returns a `gtk::TextView` Get whether the gutter renderer is visible. # Returns `true` if the renderer is visible, `false` otherwise Get the `gtk::TextWindowType` associated with the gutter renderer. # Returns a `gtk::TextWindowType` Get whether the renderer is activatable at the location in `event`. This is called from `Gutter` to determine whether a renderer is activatable using the mouse pointer. ## `iter` a `gtk::TextIter` at the start of the line to be activated ## `area` a `gdk::Rectangle` of the cell area to be activated ## `event` the event that triggered the query # Returns `true` if the renderer can be activated, `false` otherwise Emit the `GutterRenderer::query-data` signal. This function is called to query for data just before rendering a cell. This is called from the `Gutter`. Implementations can override the default signal handler or can connect a signal handler externally to the `GutterRenderer::query-data` signal. ## `start` a `gtk::TextIter`. ## `end` a `gtk::TextIter`. ## `state` a `GutterRendererState`. Emits the `GutterRenderer::query-tooltip` signal. This function is called from `Gutter`. Implementations can override the default signal handler or can connect to the signal externally. ## `iter` a `gtk::TextIter`. ## `area` a `gdk::Rectangle`. ## `x` The x position of the tooltip. ## `y` The y position of the tooltip. ## `tooltip` a `gtk::Tooltip`. # Returns `true` if the tooltip has been set, `false` otherwise Emits the `GutterRenderer::queue-draw` signal of the renderer. Call this from an implementation to inform that the renderer has changed such that it needs to redraw. Set the alignment of the gutter renderer. Both `xalign` and `yalign` can be -1, which means the values will not be changed (this allows changing only one of the values). `xalign` is the horizontal alignment. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. `yalign` is the vertical alignment. Set to 0 for a top alignment. 1 for a bottom alignment. ## `xalign` the x-alignment ## `yalign` the y-alignment Set the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign). ## `mode` a `GutterRendererAlignmentMode` Set the background color of the renderer. If `color` is set to `None`, the renderer will not have a background color. ## `color` a `gdk::RGBA` or `None` Set the padding of the gutter renderer. Both `xpad` and `ypad` can be -1, which means the values will not be changed (this allows changing only one of the values). `xpad` is the left and right padding. `ypad` is the top and bottom padding. ## `xpad` the x-padding ## `ypad` the y-padding Sets the size of the renderer. A value of -1 specifies that the size is to be determined dynamically. ## `size` the size Set whether the gutter renderer is visible. ## `visible` the visibility The ::activate signal is emitted when the renderer is activated. ## `iter` a `gtk::TextIter` ## `area` a `gdk::Rectangle` ## `event` the event that caused the activation The ::query-activatable signal is emitted when the renderer can possibly be activated. ## `iter` a `gtk::TextIter` ## `area` a `gdk::Rectangle` ## `event` the ``GdkEvent`` that is causing the activatable query The ::query-data signal is emitted when the renderer needs to be filled with data just before a cell is drawn. This can be used by general renderer implementations to allow render data to be filled in externally. ## `start` a `gtk::TextIter` ## `end` a `gtk::TextIter` ## `state` the renderer state The ::query-tooltip signal is emitted when the renderer can show a tooltip. ## `iter` a `gtk::TextIter` ## `area` a `gdk::Rectangle` ## `x` the x position (in window coordinates) ## `y` the y position (in window coordinates) ## `tooltip` a `gtk::Tooltip` The ::queue-draw signal is emitted when the renderer needs to be redrawn. Use `GutterRendererExt::queue_draw` to emit this signal from an implementation of the `GutterRenderer` interface. The alignment mode of the renderer. This can be used to indicate that in the case a cell spans multiple lines (due to text wrapping) the alignment should work on either the full cell, the first line or the last line. The alignment mode of the renderer. This can be used to indicate that in the case a cell spans multiple lines (due to text wrapping) the alignment should work on either the full cell, the first line or the last line. The view on which the renderer is placed. The visibility of the renderer. The visibility of the renderer. The window type of the view on which the renderer is placed (left, or right). The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment. The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment. The left and right padding of the renderer. The left and right padding of the renderer. The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment. The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment. The top and bottom padding of the renderer. The top and bottom padding of the renderer. The alignment mode of the renderer, when a cell spans multiple lines (due to text wrapping). The full cell. The first line. The last line. # Implements [`GutterRendererPixbufExt`](trait.GutterRendererPixbufExt.html), [`GutterRendererExt`](trait.GutterRendererExt.html) Trait containing all `GutterRendererPixbuf` methods. # Implementors [`GutterRendererPixbuf`](struct.GutterRendererPixbuf.html) Create a new `GutterRendererPixbuf`. # Returns A `GutterRenderer` Get the gicon of the renderer # Returns a `gio::Icon` Get the pixbuf of the renderer. # Returns a `gdk_pixbuf::Pixbuf` # Deprecated since 3.10 Don't use this function. # Returns the stock id. ## `icon` the icon, or `None`. ## `icon_name` the icon name, or `None`. ## `pixbuf` the pixbuf, or `None`. # Deprecated since 3.10 Don't use this function. ## `stock_id` the stock id The stock id. # Deprecated since 3.10 Don't use this property. The stock id. # Deprecated since 3.10 Don't use this property. # Implements [`GutterRendererTextExt`](trait.GutterRendererTextExt.html), [`GutterRendererExt`](trait.GutterRendererExt.html) Trait containing all `GutterRendererText` methods. # Implementors [`GutterRendererText`](struct.GutterRendererText.html) Create a new `GutterRendererText`. # Returns A `GutterRenderer` Measures the text provided using the pango layout used by the `GutterRendererText`. ## `text` the text to measure. ## `width` location to store the width of the text in pixels, or `None`. ## `height` location to store the height of the text in pixels, or `None`. Measures the pango markup provided using the pango layout used by the `GutterRendererText`. ## `markup` the pango markup to measure. ## `width` location to store the width of the text in pixels, or `None`. ## `height` location to store the height of the text in pixels, or `None`. # Implements [`LanguageExt`](trait.LanguageExt.html) Trait containing all `Language` methods. # Implementors [`Language`](struct.Language.html) Returns the globs associated to this language. This is just an utility wrapper around `LanguageExt::get_metadata` to retrieve the "globs" metadata property and split it into an array. # Returns a newly-allocated `None` terminated array containing the globs or `None` if no globs are found. The returned array must be freed with `g_strfreev`. Returns whether the language should be hidden from the user. # Returns `true` if the language should be hidden, `false` otherwise. Returns the ID of the language. The ID is not locale-dependent. The returned string is owned by `self` and should not be freed or modified. # Returns the ID of `self`. ## `name` metadata property name. # Returns value of property `name` stored in the metadata of `self` or `None` if language does not contain the specified metadata property. The returned string is owned by `self` and should not be freed or modified. Returns the mime types associated to this language. This is just an utility wrapper around `LanguageExt::get_metadata` to retrieve the "mimetypes" metadata property and split it into an array. # Returns a newly-allocated `None` terminated array containing the mime types or `None` if no mime types are found. The returned array must be freed with `g_strfreev`. Returns the localized name of the language. The returned string is owned by `self` and should not be freed or modified. # Returns the name of `self`. Returns the localized section of the language. Each language belong to a section (ex. HTML belogs to the Markup section). The returned string is owned by `self` and should not be freed or modified. # Returns the section of `self`. Returns the ID of the style to use if the specified `style_id` is not present in the current style scheme. Feature: `v3_4` ## `style_id` a style ID. # Returns the ID of the style to use if the specified `style_id` is not present in the current style scheme or `None` if the style has no fallback defined. The returned string is owned by the `self` and must not be modified. Returns the ids of the styles defined by this `self`. # Returns a newly-allocated `None` terminated array containing ids of the styles defined by this `self` or `None` if no style is defined. The returned array must be freed with `g_strfreev`. Returns the name of the style with ID `style_id` defined by this `self`. ## `style_id` a style ID. # Returns the name of the style with ID `style_id` defined by this `self` or `None` if the style has no name or there is no style with ID `style_id` defined by this `self`. The returned string is owned by the `self` and must not be modified. # Implements [`LanguageManagerExt`](trait.LanguageManagerExt.html) Trait containing all `LanguageManager` methods. # Implementors [`LanguageManager`](struct.LanguageManager.html) Creates a new language manager. If you do not need more than one language manager or a private language manager instance then use `LanguageManager::get_default` instead. # Returns a new `LanguageManager`. Returns the default `LanguageManager` instance. # Returns a `LanguageManager`. Return value is owned by `View` library and must not be unref'ed. Gets the `Language` identified by the given `id` in the language manager. ## `id` a language id. # Returns a `Language`, or `None` if there is no language identified by the given `id`. Return value is owned by `self` and should not be freed. Returns the ids of the available languages. # Returns a `None`-terminated array of strings containing the ids of the available languages or `None` if no language is available. The array is sorted alphabetically according to the language name. The array is owned by `self` and must not be modified. Gets the list directories where `self` looks for language files. # Returns `None`-terminated array containg a list of language files directories. The array is owned by `self` and must not be modified. Picks a `Language` for given file name and content type, according to the information in lang files. Either `filename` or `content_type` may be `None`. This function can be used as follows: ```` `Language` *lang; lang = gtk_source_language_manager_guess_language (filename, NULL); gtk_source_buffer_set_language (buffer, lang); ```` or ```` `Language` *lang = NULL; gboolean result_uncertain; gchar *content_type; content_type = g_content_type_guess (filename, NULL, 0, &result_uncertain); if (result_uncertain) { g_free (content_type); content_type = NULL; } lang = gtk_source_language_manager_guess_language (manager, filename, content_type); gtk_source_buffer_set_language (buffer, lang); g_free (content_type); ```` etc. Use `LanguageExt::get_mime_types` and `LanguageExt::get_globs` if you need full control over file -> language mapping. ## `filename` a filename in Glib filename encoding, or `None`. ## `content_type` a content type (as in GIO API), or `None`. # Returns a `Language`, or `None` if there is no suitable language for given `filename` and/or `content_type`. Return value is owned by `self` and should not be freed. Sets the list of directories where the `self` looks for language files. If `dirs` is `None`, the search path is reset to default. `` `` At the moment this function can be called only before the language files are loaded for the first time. In practice to set a custom search path for a `LanguageManager`, you have to call this function right after creating it. `` `` ## `dirs` a `None`-terminated array of strings or `None`. Feature: `v3_18` # Implements [`MapExt`](trait.MapExt.html), [`ViewExt`](trait.ViewExt.html), [`gtk::TextViewExt`](../gtk/trait.TextViewExt.html), [`gtk::ContainerExt`](../gtk/trait.ContainerExt.html), [`gtk::WidgetExt`](../gtk/trait.WidgetExt.html), [`gtk::BuildableExt`](../gtk/trait.BuildableExt.html), [`gtk::ScrollableExt`](../gtk/trait.ScrollableExt.html) Trait containing all `Map` methods. Feature: `v3_18` # Implementors [`Map`](struct.Map.html) Creates a new `Map`. Feature: `v3_18` # Returns a new `Map`. Gets the `Map:view` property, which is the view this widget is mapping. Feature: `v3_18` # Returns a `View` or `None`. Sets the view that `self` will be doing the mapping to. Feature: `v3_18` ## `view` a `View` # Implements [`MarkExt`](trait.MarkExt.html), [`gtk::TextMarkExt`](../gtk/trait.TextMarkExt.html) Trait containing all `Mark` methods. # Implementors [`Mark`](struct.Mark.html) Creates a text mark. Add it to a buffer using `gtk::TextBufferExt::add_mark`. If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using `gtk::TextBufferExt::get_mark`. Normally marks are created using the utility function `BufferExt::create_source_mark`. ## `name` Name of the `Mark`, can be NULL when not using a name ## `category` is used to classify marks according to common characteristics (e.g. all the marks representing a bookmark could belong to the "bookmark" category, or all the marks representing a compilation error could belong to "error" category). # Returns a new `Mark` that can be added using `gtk::TextBufferExt::add_mark`. Returns the mark category. # Returns the category of the `Mark`. Returns the next `Mark` in the buffer or `None` if the mark was not added to a buffer. If there is no next mark, `None` will be returned. If `category` is `None`, looks for marks of any category. ## `category` a string specifying the mark category, or `None`. # Returns the next `Mark`, or `None`. Returns the previous `Mark` in the buffer or `None` if the mark was not added to a buffer. If there is no previous mark, `None` is returned. If `category` is `None`, looks for marks of any category ## `category` a string specifying the mark category, or `None`. # Returns the previous `Mark`, or `None`. The category of the `Mark`, classifies the mark and controls which pixbuf is used and with which priority it is drawn. The category of the `Mark`, classifies the mark and controls which pixbuf is used and with which priority it is drawn. # Implements [`MarkAttributesExt`](trait.MarkAttributesExt.html) Trait containing all `MarkAttributes` methods. # Implementors [`MarkAttributes`](struct.MarkAttributes.html) Creates a new source mark attributes. # Returns a new source mark attributes. Stores background color in `background`. ## `background` a `gdk::RGBA`. # Returns whether background color for `self` was set. Gets a `gio::Icon` to be used as a base for rendered icon. Note that the icon can be `None` if it wasn't set earlier. # Returns An icon. The icon belongs to `self` and should not be unreffed. Gets a name of an icon to be used as a base for rendered icon. Note that the icon name can be `None` if it wasn't set earlier. # Returns An icon name. The string belongs to `self` and should not be freed. Gets a `gdk_pixbuf::Pixbuf` to be used as a base for rendered icon. Note that the pixbuf can be `None` if it wasn't set earlier. # Returns A pixbuf. The pixbuf belongs to `self` and should not be unreffed. Gets a stock id of an icon used by this attributes. Note that the stock id can be `None` if it wasn't set earlier. # Deprecated since 3.10 Don't use this function. # Returns Stock id. Returned string is owned by `self` and shouldn't be freed. Queries for a tooltip by emitting a `MarkAttributes::query-tooltip-markup` signal. The tooltip may contain a markup. ## `mark` a `Mark`. # Returns A tooltip. The returned string should be freed by using `g_free` when done with it. Queries for a tooltip by emitting a `MarkAttributes::query-tooltip-text` signal. The tooltip is a plain text. ## `mark` a `Mark`. # Returns A tooltip. The returned string should be freed by using `g_free` when done with it. Renders an icon of given size. The base of the icon is set by the last call to one of: `MarkAttributesExt::set_pixbuf`, `MarkAttributesExt::set_gicon`, `MarkAttributesExt::set_icon_name` or `MarkAttributesExt::set_stock_id`. `size` cannot be lower than 1. ## `widget` widget of which style settings may be used. ## `size` size of the rendered icon. # Returns A rendered pixbuf. The pixbuf belongs to `self` and should not be unreffed. Sets background color to the one given in `background`. ## `background` a `gdk::RGBA`. Sets an icon to be used as a base for rendered icon. ## `gicon` a `gio::Icon` to be used. Sets a name of an icon to be used as a base for rendered icon. ## `icon_name` name of an icon to be used. Sets a pixbuf to be used as a base for rendered icon. ## `pixbuf` a `gdk_pixbuf::Pixbuf` to be used. Sets stock id to be used as a base for rendered icon. # Deprecated since 3.10 Don't use this function. ## `stock_id` a stock id. The code should connect to this signal to provide a tooltip for given `mark`. The tooltip can contain a markup. ## `mark` The `Mark`. # Returns A tooltip. The string should be freed with `g_free` when done with it. The code should connect to this signal to provide a tooltip for given `mark`. The tooltip should be just a plain text. ## `mark` The `Mark`. # Returns A tooltip. The string should be freed with `g_free` when done with it. A color used for background of a line. A color used for background of a line. A `gio::Icon` that may be a base of a rendered icon. A `gio::Icon` that may be a base of a rendered icon. An icon name that may be a base of a rendered icon. An icon name that may be a base of a rendered icon. A `gdk_pixbuf::Pixbuf` that may be a base of a rendered icon. A `gdk_pixbuf::Pixbuf` that may be a base of a rendered icon. A stock id that may be a base of a rendered icon. # Deprecated since 3.10 Don't use this property. A stock id that may be a base of a rendered icon. # Deprecated since 3.10 Don't use this property. line feed, used on UNIX. carriage return, used on Mac. carriage return followed by a line feed, used on Windows. Feature: `v3_14` # Implements [`PrintCompositorExt`](trait.PrintCompositorExt.html) Trait containing all `PrintCompositor` methods. # Implementors [`PrintCompositor`](struct.PrintCompositor.html) Creates a new print compositor that can be used to print `buffer`. ## `buffer` the `Buffer` to print. # Returns a new print compositor object. Creates a new print compositor that can be used to print the buffer associated with `view`. This constructor sets some configuration properties to make the printed output match `view` as much as possible. The properties set are `PrintCompositor:tab-width`, `PrintCompositor:highlight-syntax`, `PrintCompositor:wrap-mode`, `PrintCompositor:body-font-name` and `PrintCompositor:print-line-numbers`. ## `view` a `View` to get configuration from. # Returns a new print compositor object. Draw page `page_nr` for printing on the the Cairo context encapsuled in `context`. This method has been designed to be called in the handler of the `gtk::PrintOperation::draw_page` signal as shown in the following example: ```` // Signal handler for the `gtk::PrintOperation`::draw_page signal static void draw_page (`gtk::PrintOperation` *operation, `gtk::PrintContext` *context, gint page_nr, gpointer user_data) { `PrintCompositor` *compositor; compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data); gtk_source_print_compositor_draw_page (compositor, context, page_nr); } ```` ## `context` the `gtk::PrintContext` encapsulating the context information that is required when drawing the page for printing. ## `page_nr` the number of the page to print. Returns the name of the font used to print the text body. The returned string must be freed with `g_free`. # Returns a new string containing the name of the font used to print the text body. Gets the bottom margin in units of `unit`. ## `unit` the unit for the return value. # Returns the bottom margin. Gets the `Buffer` associated with the compositor. The returned object reference is owned by the compositor object and should not be unreferenced. # Returns the `Buffer` associated with the compositor. Returns the name of the font used to print the page footer. The returned string must be freed with `g_free`. # Returns a new string containing the name of the font used to print the page footer. Returns the name of the font used to print the page header. The returned string must be freed with `g_free`. # Returns a new string containing the name of the font used to print the page header. Determines whether the printed text will be highlighted according to the buffer rules. Note that highlighting will happen only if the buffer to print has highlighting activated. # Returns `true` if the printed output will be highlighted. Gets the left margin in units of `unit`. ## `unit` the unit for the return value. # Returns the left margin Returns the name of the font used to print line numbers on the left margin. The returned string must be freed with `g_free`. # Returns a new string containing the name of the font used to print line numbers on the left margin. Returns the number of pages in the document or ``-1`` if the document has not been completely paginated. # Returns the number of pages in the document or ``-1`` if the document has not been completely paginated. Returns the current fraction of the document pagination that has been completed. # Returns a fraction from 0.0 to 1.0 inclusive. Determines if a footer is set to be printed for each page. A footer will be printed if this function returns `true` ``and`` some format strings have been specified with `PrintCompositorExt::set_footer_format`. # Returns `true` if the footer is set to be printed. Determines if a header is set to be printed for each page. A header will be printed if this function returns `true` ``and`` some format strings have been specified with `PrintCompositorExt::set_header_format`. # Returns `true` if the header is set to be printed. Returns the interval used for line number printing. If the value is 0, no line numbers will be printed. The default value is 1 (i.e. numbers printed in all lines). # Returns the interval of printed line numbers. Gets the right margin in units of `unit`. ## `unit` the unit for the return value. # Returns the right margin. Returns the width of tabulation in characters for printed text. # Returns width of tab. Gets the top margin in units of `unit`. ## `unit` the unit for the return value. # Returns the top margin. Gets the line wrapping mode for the printed text. # Returns the line wrap mode. Paginate the document associated with the `self`. In order to support non-blocking pagination, document is paginated in small chunks. Each time `PrintCompositorExt::paginate` is invoked, a chunk of the document is paginated. To paginate the entire document, `PrintCompositorExt::paginate` must be invoked multiple times. It returns `true` if the document has been completely paginated, otherwise it returns `false`. This method has been designed to be invoked in the handler of the `gtk::PrintOperation::paginate` signal, as shown in the following example: ```` // Signal handler for the `gtk::PrintOperation`::paginate signal static gboolean paginate (`gtk::PrintOperation` *operation, `gtk::PrintContext` *context, gpointer user_data) { `PrintCompositor` *compositor; compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data); if (gtk_source_print_compositor_paginate (compositor, context)) { gint n_pages; n_pages = gtk_source_print_compositor_get_n_pages (compositor); gtk_print_operation_set_n_pages (operation, n_pages); return TRUE; } return FALSE; } ```` If you don't need to do pagination in chunks, you can simply do it all in the `gtk::PrintOperation::begin-print` handler, and set the number of pages from there, like in the following example: ```` // Signal handler for the `gtk::PrintOperation`::begin-print signal static void begin_print (`gtk::PrintOperation` *operation, `gtk::PrintContext` *context, gpointer user_data) { `PrintCompositor` *compositor; gint n_pages; compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data); while (!gtk_source_print_compositor_paginate (compositor, context)); n_pages = gtk_source_print_compositor_get_n_pages (compositor); gtk_print_operation_set_n_pages (operation, n_pages); } ```` ## `context` the `gtk::PrintContext` whose parameters (e.g. paper size, print margins, etc.) are used by the the `self` to paginate the document. # Returns `true` if the document has been completely paginated, `false` otherwise. Sets the default font for the printed text. `font_name` should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `font_name` the name of the default font for the body text. Sets the bottom margin used by `self`. ## `margin` the new bottom margin in units of `unit`. ## `unit` the units for `margin`. Sets the font for printing the page footer. If `None` is supplied, the default font (i.e. the one being used for the text) will be used instead. `font_name` should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `font_name` the name of the font for the footer text, or `None`. See `PrintCompositorExt::set_header_format` for more information about the parameters. ## `separator` `true` if you want a separator line to be printed. ## `left` a format string to print on the left of the footer. ## `center` a format string to print on the center of the footer. ## `right` a format string to print on the right of the footer. Sets the font for printing the page header. If `None` is supplied, the default font (i.e. the one being used for the text) will be used instead. `font_name` should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `font_name` the name of the font for header text, or `None`. Sets strftime like header format strings, to be printed on the left, center and right of the top of each page. The strings may include strftime(3) codes which will be expanded at print time. A subset of `strftime` codes are accepted, see `glib::DateTime::format` for more details on the accepted format specifiers. Additionally the following format specifiers are accepted: - `N`: the page number - `Q`: the page count. `separator` specifies if a solid line should be drawn to separate the header from the document text. If `None` is given for any of the three arguments, that particular string will not be printed. For the header to be printed, in addition to specifying format strings, you need to enable header printing with `PrintCompositorExt::set_print_header`. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `separator` `true` if you want a separator line to be printed. ## `left` a format string to print on the left of the header. ## `center` a format string to print on the center of the header. ## `right` a format string to print on the right of the header. Sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `highlight` whether syntax should be highlighted. Sets the left margin used by `self`. ## `margin` the new left margin in units of `unit`. ## `unit` the units for `margin`. Sets the font for printing line numbers on the left margin. If `None` is supplied, the default font (i.e. the one being used for the text) will be used instead. `font_name` should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `font_name` the name of the font for line numbers, or `None`. Sets whether you want to print a footer in each page. The footer consists of three pieces of text and an optional line separator, configurable with `PrintCompositorExt::set_footer_format`. Note that by default the footer format is unspecified, and if it's empty it will not be printed, regardless of this setting. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `print` `true` if you want the footer to be printed. Sets whether you want to print a header in each page. The header consists of three pieces of text and an optional line separator, configurable with `PrintCompositorExt::set_header_format`. Note that by default the header format is unspecified, and if it's empty it will not be printed, regardless of this setting. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `print` `true` if you want the header to be printed. Sets the interval for printed line numbers. If `interval` is 0 no numbers will be printed. If greater than 0, a number will be printed every `interval` lines (i.e. 1 will print all line numbers). Maximum accepted value for `interval` is 100. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `interval` interval for printed line numbers. Sets the right margin used by `self`. ## `margin` the new right margin in units of `unit`. ## `unit` the units for `margin`. Sets the width of tabulation in characters for printed text. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `width` width of tab in characters. Sets the top margin used by `self`. ## `margin` the new top margin in units of `unit` ## `unit` the units for `margin` Sets the line wrapping mode for the printed text. This function cannot be called anymore after the first call to the `PrintCompositorExt::paginate` function. ## `wrap_mode` a `gtk::WrapMode`. Name of the font used for the text body. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Name of the font used for the text body. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. The `Buffer` object to print. The `Buffer` object to print. Name of the font used to print page footer. If this property is unspecified, the text body font is used. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Name of the font used to print page footer. If this property is unspecified, the text body font is used. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Name of the font used to print page header. If this property is unspecified, the text body font is used. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Name of the font used to print page header. If this property is unspecified, the text body font is used. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to print the document with highlighted syntax. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to print the document with highlighted syntax. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Name of the font used to print line numbers on the left margin. If this property is unspecified, the text body font is used. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Name of the font used to print line numbers on the left margin. If this property is unspecified, the text body font is used. Accepted values are strings representing a font description Pango can understand. (e.g. "Monospace 10"). See `pango::FontDescription::from_string` for a description of the format of the string representation. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. The number of pages in the document or ``-1`` if the document has not been completely paginated. Whether to print a footer in each page. Note that by default the footer format is unspecified, and if it is unspecified the footer will not be printed, regardless of the value of this property. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to print a footer in each page. Note that by default the footer format is unspecified, and if it is unspecified the footer will not be printed, regardless of the value of this property. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to print a header in each page. Note that by default the header format is unspecified, and if it is unspecified the header will not be printed, regardless of the value of this property. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to print a header in each page. Note that by default the header format is unspecified, and if it is unspecified the header will not be printed, regardless of the value of this property. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Interval of printed line numbers. If this property is set to 0 no numbers will be printed. If greater than 0, a number will be printed every "print-line-numbers" lines (i.e. 1 will print all line numbers). The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Interval of printed line numbers. If this property is set to 0 no numbers will be printed. If greater than 0, a number will be printed every "print-line-numbers" lines (i.e. 1 will print all line numbers). The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Width of a tab character expressed in spaces. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Width of a tab character expressed in spaces. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to wrap lines never, at word boundaries, or at character boundaries. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Whether to wrap lines never, at word boundaries, or at character boundaries. The value of this property cannot be changed anymore after the first call to the `PrintCompositorExt::paginate` function. Feature: `v3_22` # Implements [`RegionExt`](trait.RegionExt.html) Trait containing all `Region` methods. Feature: `v3_22` # Implementors [`Region`](struct.Region.html) Feature: `v3_22` ## `buffer` a `gtk::TextBuffer`. # Returns a new `Region` object for `buffer`. Adds `region_to_add` to `self`. `region_to_add` is not modified. Feature: `v3_22` ## `region_to_add` the `Region` to add to `self`, or `None`. Adds the subregion delimited by `_start` and `_end` to `self`. Feature: `v3_22` ## `_start` the start of the subregion. ## `_end` the end of the subregion. Gets the `start` and `end` bounds of the `self`. Feature: `v3_22` ## `start` iterator to initialize with the start of `self`, or `None`. ## `end` iterator to initialize with the end of `self`, or `None`. # Returns `true` if `start` and `end` have been set successfully (if non-`None`), or `false` if the `self` is empty. Feature: `v3_22` # Returns the `gtk::TextBuffer`. Initializes a `RegionIter` to the first subregion of `self`. If `self` is empty, `iter` will be initialized to the end iterator. Feature: `v3_22` ## `iter` iterator to initialize to the first subregion. Returns the intersection between `self` and `region2`. `self` and `region2` are not modified. Feature: `v3_22` ## `region2` a `Region`, or `None`. # Returns the intersection as a `Region` object. Returns the intersection between `self` and the subregion delimited by `_start` and `_end`. `self` is not modified. Feature: `v3_22` ## `_start` the start of the subregion. ## `_end` the end of the subregion. # Returns the intersection as a new `Region`. Returns whether the `self` is empty. A `None` `self` is considered empty. Feature: `v3_22` # Returns whether the `self` is empty. Subtracts `region_to_subtract` from `self`. `region_to_subtract` is not modified. Feature: `v3_22` ## `region_to_subtract` the `Region` to subtract from `self`, or `None`. Subtracts the subregion delimited by `_start` and `_end` from `self`. Feature: `v3_22` ## `_start` the start of the subregion. ## `_end` the end of the subregion. Gets a string represention of `self`, for debugging purposes. The returned string contains the character offsets of the subregions. It doesn't include a newline character at the end of the string. Feature: `v3_22` # Returns a string represention of `self`. Free with `g_free` when no longer needed. The `gtk::TextBuffer`. The `Region` has a weak reference to the buffer. Feature: `v3_22` The `gtk::TextBuffer`. The `Region` has a weak reference to the buffer. Feature: `v3_22` `RegionIter` is an opaque datatype; ignore all its fields. Initialize the iter with `RegionExt::get_start_region_iter`. Feature: `v3_22` Gets the subregion at this iterator. Feature: `v3_22` ## `start` iterator to initialize with the subregion start, or `None`. ## `end` iterator to initialize with the subregion end, or `None`. # Returns `true` if `start` and `end` have been set successfully (if non-`None`), or `false` if `self` is the end iterator or if the region is empty. Feature: `v3_22` # Returns whether `self` is the end iterator. Moves `self` to the next subregion. Feature: `v3_22` # Returns `true` if `self` moved and is dereferenceable, or `false` if `self` has been set to the end iterator. Feature: `v3_10` # Implements [`SearchContextExt`](trait.SearchContextExt.html) Trait containing all `SearchContext` methods. Feature: `v3_10` # Implementors [`SearchContext`](struct.SearchContext.html) Creates a new search context, associated with `buffer`, and customized with `settings`. If `settings` is `None`, a new `SearchSettings` object will be created, that you can retrieve with `SearchContextExt::get_settings`. Feature: `v3_10` ## `buffer` a `Buffer`. ## `settings` a `SearchSettings`, or `None`. # Returns a new search context. Synchronous backward search. It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the `buffer` is small, this function is more convenient to use. Feature: `v3_10` # Deprecated since 3.22 Use `SearchContextExt::backward2` instead. ## `iter` start of search. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. # Returns whether a match was found. Synchronous backward search. It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the `buffer` is small, this function is more convenient to use. The difference with `SearchContextExt::backward` is that the `has_wrapped_around` out parameter has been added for convenience. If the `SearchSettings:wrap-around` property is `false`, this function doesn't try to wrap around. The `has_wrapped_around` out parameter is set independently of whether a match is found. So if this function returns `false`, `has_wrapped_around` will have the same value as the `SearchSettings:wrap-around` property. Feature: `v3_22` ## `iter` start of search. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. ## `has_wrapped_around` return location to know whether the search has wrapped around, or `None`. # Returns whether a match was found. The asynchronous version of `SearchContextExt::backward2`. See the documentation of `SearchContextExt::backward2` for more details. See the `gio::AsyncResult` documentation to know how to use this function. If the operation is cancelled, the `callback` will only be called if `cancellable` was not `None`. `SearchContextExt::backward_async` takes ownership of `cancellable`, so you can unref it after calling this function. Feature: `v3_10` ## `iter` start of search. ## `cancellable` a `gio::Cancellable`, or `None`. ## `callback` a `GAsyncReadyCallback` to call when the operation is finished. ## `user_data` the data to pass to the `callback` function. Finishes a backward search started with `SearchContextExt::backward_async`. Feature: `v3_10` # Deprecated since 3.22 Use `SearchContextExt::backward_finish2` instead. ## `result` a `gio::AsyncResult`. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. # Returns whether a match was found. Finishes a backward search started with `SearchContextExt::backward_async`. See the documentation of `SearchContextExt::backward2` for more details. Feature: `v3_22` ## `result` a `gio::AsyncResult`. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. ## `has_wrapped_around` return location to know whether the search has wrapped around, or `None`. # Returns whether a match was found. Synchronous forward search. It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the `buffer` is small, this function is more convenient to use. Feature: `v3_10` # Deprecated since 3.22 Use `SearchContextExt::forward2` instead. ## `iter` start of search. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. # Returns whether a match was found. Synchronous forward search. It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the `buffer` is small, this function is more convenient to use. The difference with `SearchContextExt::forward` is that the `has_wrapped_around` out parameter has been added for convenience. If the `SearchSettings:wrap-around` property is `false`, this function doesn't try to wrap around. The `has_wrapped_around` out parameter is set independently of whether a match is found. So if this function returns `false`, `has_wrapped_around` will have the same value as the `SearchSettings:wrap-around` property. Feature: `v3_22` ## `iter` start of search. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. ## `has_wrapped_around` return location to know whether the search has wrapped around, or `None`. # Returns whether a match was found. The asynchronous version of `SearchContextExt::forward2`. See the documentation of `SearchContextExt::forward2` for more details. See the `gio::AsyncResult` documentation to know how to use this function. If the operation is cancelled, the `callback` will only be called if `cancellable` was not `None`. `SearchContextExt::forward_async` takes ownership of `cancellable`, so you can unref it after calling this function. Feature: `v3_10` ## `iter` start of search. ## `cancellable` a `gio::Cancellable`, or `None`. ## `callback` a `GAsyncReadyCallback` to call when the operation is finished. ## `user_data` the data to pass to the `callback` function. Finishes a forward search started with `SearchContextExt::forward_async`. Feature: `v3_10` # Deprecated since 3.22 Use `SearchContextExt::forward_finish2` instead. ## `result` a `gio::AsyncResult`. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. # Returns whether a match was found. Finishes a forward search started with `SearchContextExt::forward_async`. See the documentation of `SearchContextExt::forward2` for more details. Feature: `v3_22` ## `result` a `gio::AsyncResult`. ## `match_start` return location for start of match, or `None`. ## `match_end` return location for end of match, or `None`. ## `has_wrapped_around` return location to know whether the search has wrapped around, or `None`. # Returns whether a match was found. Feature: `v3_10` # Returns the associated buffer. Feature: `v3_10` # Returns whether to highlight the search occurrences. Feature: `v3_16` # Returns the `Style` to apply on search matches. Gets the position of a search occurrence. If the buffer is not already fully scanned, the position may be unknown, and -1 is returned. If 0 is returned, it means that this part of the buffer has already been scanned, and that `match_start` and `match_end` don't delimit an occurrence. Feature: `v3_10` ## `match_start` the start of the occurrence. ## `match_end` the end of the occurrence. # Returns the position of the search occurrence. The first occurrence has the position 1 (not 0). Returns 0 if `match_start` and `match_end` don't delimit an occurrence. Returns -1 if the position is not yet known. Gets the total number of search occurrences. If the buffer is not already fully scanned, the total number of occurrences is unknown, and -1 is returned. Feature: `v3_10` # Returns the total number of search occurrences, or -1 if unknown. Regular expression patterns must follow certain rules. If `SearchSettings:search-text` breaks a rule, the error can be retrieved with this function. The error domain is `G_REGEX_ERROR`. Free the return value with `glib::Error::free`. Feature: `v3_10` # Returns the `glib::Error`, or `None` if the pattern is valid. Feature: `v3_10` # Returns the search settings. Replaces a search match by another text. If `match_start` and `match_end` doesn't correspond to a search match, `false` is returned. For a regular expression replacement, you can check if `replace` is valid by calling `glib::Regex::check_replacement`. The `replace` text can contain backreferences; read the `glib::Regex::replace` documentation for more details. Feature: `v3_10` # Deprecated since 3.22 Use `SearchContextExt::replace2` instead. ## `match_start` the start of the match to replace. ## `match_end` the end of the match to replace. ## `replace` the replacement text. ## `replace_length` the length of `replace` in bytes, or -1. # Returns whether the match has been replaced. Replaces a search match by another text. If `match_start` and `match_end` doesn't correspond to a search match, `false` is returned. Unlike with `SearchContextExt::replace`, the `match_start` and `match_end` iters are revalidated to point to the replacement text boundaries. For a regular expression replacement, you can check if `replace` is valid by calling `glib::Regex::check_replacement`. The `replace` text can contain backreferences; read the `glib::Regex::replace` documentation for more details. Feature: `v3_22` ## `match_start` the start of the match to replace. ## `match_end` the end of the match to replace. ## `replace` the replacement text. ## `replace_length` the length of `replace` in bytes, or -1. # Returns whether the match has been replaced. Replaces all search matches by another text. It is a synchronous function, so it can block the user interface. For a regular expression replacement, you can check if `replace` is valid by calling `glib::Regex::check_replacement`. The `replace` text can contain backreferences; read the `glib::Regex::replace` documentation for more details. Feature: `v3_10` ## `replace` the replacement text. ## `replace_length` the length of `replace` in bytes, or -1. # Returns the number of replaced matches. Enables or disables the search occurrences highlighting. Feature: `v3_10` ## `highlight` the setting. Set the style to apply on search matches. If `match_style` is `None`, default theme's scheme 'match-style' will be used. To enable or disable the search highlighting, use `SearchContextExt::set_highlight`. Feature: `v3_16` ## `match_style` a `Style`, or `None`. Associate a `SearchSettings` with the search context. If `settings` is `None`, a new one will be created. The search context holds a reference to `settings`. Feature: `v3_10` # Deprecated since 3.24 The `SearchContext:settings` property will become a construct-only property in a future version. Create a new `SearchContext` instead, or change the `SearchSettings` properties. When the `SearchContext:settings` property will become construct-only, it will be possible to simplify some code that needed to listen to the notify::settings signal. ## `settings` the new `SearchSettings`, or `None`. The `Buffer` associated to the search context. Feature: `v3_10` The `Buffer` associated to the search context. Feature: `v3_10` Highlight the search occurrences. Feature: `v3_10` Highlight the search occurrences. Feature: `v3_10` A `Style`, or `None` for theme's scheme default style. Feature: `v3_16` A `Style`, or `None` for theme's scheme default style. Feature: `v3_16` The total number of search occurrences. If the search is disabled, the value is 0. If the buffer is not already fully scanned, the value is -1. Feature: `v3_10` If the regex search pattern doesn't follow all the rules, this property will be set. If the pattern is valid, the value is `None`. Free with `glib::Error::free`. Feature: `v3_10` The `SearchSettings` associated to the search context. Feature: `v3_10` The `SearchSettings` associated to the search context. Feature: `v3_10` Feature: `v3_10` # Implements [`SearchSettingsExt`](trait.SearchSettingsExt.html) Trait containing all `SearchSettings` methods. Feature: `v3_10` # Implementors [`SearchSettings`](struct.SearchSettings.html) Creates a new search settings object. Feature: `v3_10` # Returns a new search settings object. Feature: `v3_10` # Returns whether to search at word boundaries. Feature: `v3_10` # Returns whether the search is case sensitive. Feature: `v3_10` # Returns whether to search by regular expressions. Gets the text to search. The return value must not be freed. You may be interested to call `gtk_source_utils_escape_search_text` after this function. Feature: `v3_10` # Returns the text to search, or `None` if the search is disabled. Feature: `v3_10` # Returns whether to wrap around the search. Change whether the search is done at word boundaries. If `at_word_boundaries` is `true`, a search match must start and end a word. The match can span multiple words. See also `gtk::TextIter::starts_word` and `gtk::TextIter::ends_word`. Feature: `v3_10` ## `at_word_boundaries` the setting. Enables or disables the case sensitivity for the search. Feature: `v3_10` ## `case_sensitive` the setting. Enables or disables whether to search by regular expressions. If enabled, the `SearchSettings:search-text` property contains the pattern of the regular expression. `SearchContext` uses `glib::Regex` when regex search is enabled. See the [Regular expression syntax](https://developer.gnome.org/glib/stable/glib-regex-syntax.html) page in the GLib reference manual. Feature: `v3_10` ## `regex_enabled` the setting. Sets the text to search. If `search_text` is `None` or is empty, the search will be disabled. A copy of `search_text` will be made, so you can safely free `search_text` after a call to this function. You may be interested to call `gtk_source_utils_unescape_search_text` before this function. Feature: `v3_10` ## `search_text` the nul-terminated text to search, or `None` to disable the search. Enables or disables the wrap around search. If `wrap_around` is `true`, the forward search continues at the beginning of the buffer if no search occurrences are found. Similarly, the backward search continues to search at the end of the buffer. Feature: `v3_10` ## `wrap_around` the setting. If `true`, a search match must start and end a word. The match can span multiple words. Feature: `v3_10` If `true`, a search match must start and end a word. The match can span multiple words. Feature: `v3_10` Whether the search is case sensitive. Feature: `v3_10` Whether the search is case sensitive. Feature: `v3_10` Search by regular expressions with `SearchSettings:search-text` as the pattern. Feature: `v3_10` Search by regular expressions with `SearchSettings:search-text` as the pattern. Feature: `v3_10` A search string, or `None` if the search is disabled. If the regular expression search is enabled, `SearchSettings:search-text` is the pattern. Feature: `v3_10` A search string, or `None` if the search is disabled. If the regular expression search is enabled, `SearchSettings:search-text` is the pattern. Feature: `v3_10` For a forward search, continue at the beginning of the buffer if no search occurrence is found. For a backward search, continue at the end of the buffer. Feature: `v3_10` For a forward search, continue at the beginning of the buffer if no search occurrence is found. For a backward search, continue at the end of the buffer. Feature: `v3_10` smart-home-end disabled. move to the first/last non-whitespace character on the first press of the HOME/END keys and to the beginning/end of the line on the second press. move to the beginning/end of the line on the first press of the HOME/END keys and to the first/last non-whitespace character on the second press. always move to the first/last non-whitespace character when the HOME/END keys are pressed. Feature: `v3_24` # Implements [`SpaceDrawerExt`](trait.SpaceDrawerExt.html) Trait containing all `SpaceDrawer` methods. Feature: `v3_24` # Implementors [`SpaceDrawer`](struct.SpaceDrawer.html) Creates a new `SpaceDrawer` object. Useful for storing space drawing settings independently of a `View`. Feature: `v3_24` # Returns a new `SpaceDrawer`. Binds the `SpaceDrawer:matrix` property to a `gio::Settings` key. The `gio::Settings` key must be of the same type as the `SpaceDrawer:matrix` property, that is, `"au"`. The `gio::SettingsExt::bind` function cannot be used, because the default GIO mapping functions don't support `glib::Variant` properties (maybe it will be supported by a future GIO version, in which case this function can be deprecated). Feature: `v3_24` ## `settings` a `gio::Settings` object. ## `key` the `settings` key to bind. ## `flags` flags for the binding. Feature: `v3_24` # Returns whether the `SpaceDrawer:matrix` property is enabled. Gets the value of the `SpaceDrawer:matrix` property, as a `glib::Variant`. An empty array can be returned in case the matrix is a zero matrix. The `SpaceDrawerExt::get_types_for_locations` function may be more convenient to use. Feature: `v3_24` # Returns the `SpaceDrawer:matrix` value as a new floating `glib::Variant` instance. If only one location is specified, this function returns what kind of white spaces are drawn at that location. The value is retrieved from the `SpaceDrawer:matrix` property. If several locations are specified, this function returns the logical AND for those locations. Which means that if a certain kind of white space is present in the return value, then that kind of white space is drawn at all the specified `locations`. Feature: `v3_24` ## `locations` one or several `SpaceLocationFlags`. # Returns a combination of `SpaceTypeFlags`. Sets whether the `SpaceDrawer:matrix` property is enabled. Feature: `v3_24` ## `enable_matrix` the new value. Sets a new value to the `SpaceDrawer:matrix` property, as a `glib::Variant`. If `matrix` is `None`, then an empty array is set. If `matrix` is floating, it is consumed. The `SpaceDrawerExt::set_types_for_locations` function may be more convenient to use. Feature: `v3_24` ## `matrix` the new matrix value, or `None`. Modifies the `SpaceDrawer:matrix` property at the specified `locations`. Feature: `v3_24` ## `locations` one or several `SpaceLocationFlags`. ## `types` a combination of `SpaceTypeFlags`. Whether the `SpaceDrawer:matrix` property is enabled. Feature: `v3_24` Whether the `SpaceDrawer:matrix` property is enabled. Feature: `v3_24` The :matrix property is a `glib::Variant` property to specify where and what kind of white spaces to draw. The `glib::Variant` is of type `"au"`, an array of unsigned integers. Each integer is a combination of `SpaceTypeFlags`. There is one integer for each `SpaceLocationFlags`, in the same order as they are defined in the enum (`SpaceLocationFlags::None` and `SpaceLocationFlags::All` are not taken into account). If the array is shorter than the number of locations, then the value for the missing locations will be `SpaceTypeFlags::None`. By default, `SpaceTypeFlags::All` is set for all locations. Feature: `v3_24` The :matrix property is a `glib::Variant` property to specify where and what kind of white spaces to draw. The `glib::Variant` is of type `"au"`, an array of unsigned integers. Each integer is a combination of `SpaceTypeFlags`. There is one integer for each `SpaceLocationFlags`, in the same order as they are defined in the enum (`SpaceLocationFlags::None` and `SpaceLocationFlags::All` are not taken into account). If the array is shorter than the number of locations, then the value for the missing locations will be `SpaceTypeFlags::None`. By default, `SpaceTypeFlags::All` is set for all locations. Feature: `v3_24` This function modifies the `gtk::TextTag` properties that are related to the `Style` properties. Other `gtk::TextTag` properties are left untouched. If `self` is non-`None`, applies `self` to `tag`. If `self` is `None`, the related *-set properties of `gtk::TextTag` are set to `false`. Feature: `v3_22` ## `tag` a `gtk::TextTag` to apply styles to. Creates a copy of `self`, that is a new `Style` instance which has the same attributes set. # Returns copy of `self`, call `gobject::Object::unref` when you are done with it. # Deprecated since 3.18 Use pango-underline. # Deprecated since 3.18 Use pango-underline. # Implements [`StyleSchemeExt`](trait.StyleSchemeExt.html) Trait containing all `StyleScheme` methods. # Implementors [`StyleScheme`](struct.StyleScheme.html) # Returns a `None`-terminated array containing the `self` authors or `None` if no author is specified by the style scheme. # Returns `self` description (if defined), or `None`. # Returns `self` file name if the scheme was created parsing a style scheme file or `None` in the other cases. # Returns `self` id. # Returns `self` name. ## `style_id` id of the style to retrieve. # Returns style which corresponds to `style_id` in the `self`, or `None` when no style with this name found. It is owned by `self` and may not be unref'ed. Style scheme description, a translatable string to present to the user. Style scheme filename or `None`. Style scheme id, a unique string used to identify the style scheme in `StyleSchemeManager`. Style scheme id, a unique string used to identify the style scheme in `StyleSchemeManager`. Style scheme name, a translatable string to present to the user. Feature: `v3_16` # Implements [`StyleSchemeChooserExt`](trait.StyleSchemeChooserExt.html) Trait containing all `StyleSchemeChooser` methods. Feature: `v3_16` # Implementors [`StyleSchemeChooserButton`](struct.StyleSchemeChooserButton.html), [`StyleSchemeChooserWidget`](struct.StyleSchemeChooserWidget.html), [`StyleSchemeChooser`](struct.StyleSchemeChooser.html) Gets the currently-selected scheme. Feature: `v3_16` # Returns the currently-selected scheme. Sets the scheme. Feature: `v3_16` ## `scheme` a `StyleScheme` The :style-scheme property contains the currently selected style scheme. The property can be set to change the current selection programmatically. Feature: `v3_16` The :style-scheme property contains the currently selected style scheme. The property can be set to change the current selection programmatically. Feature: `v3_16` Feature: `v3_16` # Implements [`gtk::ButtonExt`](../gtk/trait.ButtonExt.html), [`gtk::BinExt`](../gtk/trait.BinExt.html), [`gtk::ContainerExt`](../gtk/trait.ContainerExt.html), [`gtk::WidgetExt`](../gtk/trait.WidgetExt.html), [`gtk::BuildableExt`](../gtk/trait.BuildableExt.html), [`gtk::ActionableExt`](../gtk/trait.ActionableExt.html), [`StyleSchemeChooserExt`](trait.StyleSchemeChooserExt.html) Creates a new `StyleSchemeChooserButton`. Feature: `v3_16` # Returns a new `StyleSchemeChooserButton`. Feature: `v3_16` # Implements [`gtk::BinExt`](../gtk/trait.BinExt.html), [`gtk::ContainerExt`](../gtk/trait.ContainerExt.html), [`gtk::WidgetExt`](../gtk/trait.WidgetExt.html), [`gtk::BuildableExt`](../gtk/trait.BuildableExt.html), [`StyleSchemeChooserExt`](trait.StyleSchemeChooserExt.html) Creates a new `StyleSchemeChooserWidget`. Feature: `v3_16` # Returns a new `StyleSchemeChooserWidget`. # Implements [`StyleSchemeManagerExt`](trait.StyleSchemeManagerExt.html) Trait containing all `StyleSchemeManager` methods. # Implementors [`StyleSchemeManager`](struct.StyleSchemeManager.html) Creates a new style manager. If you do not need more than one style manager then use `StyleSchemeManager::get_default` instead. # Returns a new `StyleSchemeManager`. Returns the default `StyleSchemeManager` instance. # Returns a `StyleSchemeManager`. Return value is owned by `View` library and must not be unref'ed. Appends `path` to the list of directories where the `self` looks for style scheme files. See `StyleSchemeManagerExt::set_search_path` for details. ## `path` a directory or a filename. Mark any currently cached information about the available style scehems as invalid. All the available style schemes will be reloaded next time the `self` is accessed. Looks up style scheme by id. ## `scheme_id` style scheme id to find. # Returns a `StyleScheme` object. Returned value is owned by `self` and must not be unref'ed. Returns the ids of the available style schemes. # Returns a `None`-terminated array of strings containing the ids of the available style schemes or `None` if no style scheme is available. The array is sorted alphabetically according to the scheme name. The array is owned by the `self` and must not be modified. Returns the current search path for the `self`. See `StyleSchemeManagerExt::set_search_path` for details. # Returns a `None`-terminated array of string containing the search path. The array is owned by the `self` and must not be modified. Prepends `path` to the list of directories where the `self` looks for style scheme files. See `StyleSchemeManagerExt::set_search_path` for details. ## `path` a directory or a filename. Sets the list of directories where the `self` looks for style scheme files. If `path` is `None`, the search path is reset to default. ## `path` a `None`-terminated array of strings or `None`. Feature: `v3_20` # Implements [`TagExt`](trait.TagExt.html), [`gtk::TextTagExt`](../gtk/trait.TextTagExt.html) Trait containing all `Tag` methods. Feature: `v3_20` # Implementors [`Tag`](struct.Tag.html) Creates a `Tag`. Configure the tag using object arguments, i.e. using `gobject::Object::set`. For usual cases, `BufferExt::create_source_tag` is more convenient to use. Feature: `v3_20` ## `name` tag name, or `None`. # Returns a new `Tag`. Whether to draw white spaces. This property takes precedence over the value defined by the `SpaceDrawer`'s `SpaceDrawer:matrix` property (only where the tag is applied). Setting this property also changes `Tag:draw-spaces-set` to `true`. Feature: `v3_20` Whether to draw white spaces. This property takes precedence over the value defined by the `SpaceDrawer`'s `SpaceDrawer:matrix` property (only where the tag is applied). Setting this property also changes `Tag:draw-spaces-set` to `true`. Feature: `v3_20` Whether the `Tag:draw-spaces` property is set and must be taken into account. Feature: `v3_20` Whether the `Tag:draw-spaces` property is set and must be taken into account. Feature: `v3_20` # Implements [`UndoManagerExt`](trait.UndoManagerExt.html) Trait containing all `UndoManager` methods. # Implementors [`UndoManager`](struct.UndoManager.html) Begin a not undoable action on the buffer. All changes between this call and the call to `UndoManager::end_not_undoable_action` cannot be undone. This function should be re-entrant. Get whether there are redo operations available. # Returns `true` if there are redo operations available, `false` otherwise Emits the `UndoManager::can-redo-changed` signal. Get whether there are undo operations available. # Returns `true` if there are undo operations available, `false` otherwise Emits the `UndoManager::can-undo-changed` signal. Ends a not undoable action on the buffer. Perform a single redo. Calling this function when there are no redo operations available is an error. Use `UndoManager::can_redo` to find out if there are redo operations available. Perform a single undo. Calling this function when there are no undo operations available is an error. Use `UndoManager::can_undo` to find out if there are undo operations available. Emitted when the ability to redo has changed. Emitted when the ability to undo has changed. # Implements [`ViewExt`](trait.ViewExt.html), [`gtk::TextViewExt`](../gtk/trait.TextViewExt.html), [`gtk::ContainerExt`](../gtk/trait.ContainerExt.html), [`gtk::WidgetExt`](../gtk/trait.WidgetExt.html), [`gtk::BuildableExt`](../gtk/trait.BuildableExt.html), [`gtk::ScrollableExt`](../gtk/trait.ScrollableExt.html) Trait containing all `View` methods. # Implementors [`Map`](struct.Map.html), [`View`](struct.View.html) Creates a new `View`. By default, an empty `Buffer` will be lazily created and can be retrieved with `gtk::TextViewExt::get_buffer`. If you want to specify your own buffer, either override the `gtk::TextViewClass` create_buffer factory method, or use `View::new_with_buffer`. # Returns a new `View`. Creates a new `View` widget displaying the buffer `buffer`. One buffer can be shared among many widgets. ## `buffer` a `Buffer`. # Returns a new `View`. Returns whether auto-indentation of text is enabled. # Returns `true` if auto indentation is enabled. Returns the `BackgroundPatternType` specifying if and how the background pattern should be displayed for this `self`. Feature: `v3_16` # Returns the `BackgroundPatternType`. Gets the `Completion` associated with `self`. The returned object is guaranteed to be the same for the lifetime of `self`. Each `View` object has a different `Completion`. # Returns the `Completion` associated with `self`. Returns the `DrawSpacesFlags` specifying if and how spaces should be displayed for this `self`. # Deprecated since 3.24 Use `SpaceDrawerExt::get_types_for_locations` instead. # Returns the `DrawSpacesFlags`, 0 if no spaces should be drawn. Returns the `Gutter` object associated with `window_type` for `self`. 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. ## `window_type` the gutter window type. # Returns the `Gutter`. Returns whether the current line is highlighted. # Returns `true` if the current line is highlighted. Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character. # Returns `true` if the selection is indented when tab is pressed. Returns the number of spaces to use for each step of indent. See `ViewExt::set_indent_width` for details. # Returns indent width. Returns whether when inserting a tabulator character it should be replaced by a group of space characters. # Returns `true` if spaces are inserted instead of tabs. Gets attributes and priority for the `category`. ## `category` the category. ## `priority` place where priority of the category will be stored. # Returns `MarkAttributes` for the `category`. The object belongs to `self`, so it must not be unreffed. Gets the position of the right margin in the given `self`. # Returns the position of the right margin. Returns whether line marks are displayed beside the text. # Returns `true` if the line marks are displayed. Returns whether line numbers are displayed beside the text. # Returns `true` if the line numbers are displayed. Returns whether a right margin is displayed. # Returns `true` if the right margin is shown. Returns `true` if pressing the Backspace key will try to delete spaces up to the previous tab stop. Feature: `v3_18` # Returns `true` if smart Backspace handling is enabled. Returns a `SmartHomeEndType` end value specifying how the cursor will move when HOME and END keys are pressed. # Returns a `SmartHomeEndType` value. Gets the `SpaceDrawer` associated with `self`. The returned object is guaranteed to be the same for the lifetime of `self`. Each `View` object has a different `SpaceDrawer`. Feature: `v3_24` # Returns the `SpaceDrawer` associated with `self`. Returns the width of tabulation in characters. # Returns width of tab. Determines the visual column at `iter` taking into consideration the `View:tab-width` of `self`. ## `iter` a position in `self`. # Returns the visual column at `iter`. Inserts one indentation level at the beginning of the specified lines. The empty lines are not indented. Feature: `v3_16` ## `start` `gtk::TextIter` of the first line to indent ## `end` `gtk::TextIter` of the last line to indent 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 ``not`` a "smart indentation" where an indentation level is added or removed depending on the context. ## `enable` whether to enable auto indentation. Set if and how the background pattern should be displayed. Feature: `v3_16` ## `background_pattern` the `BackgroundPatternType`. 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 `Tag`'s `Tag:draw-spaces` property. # Deprecated since 3.24 Use `SpaceDrawerExt::set_types_for_locations` instead. ## `flags` `DrawSpacesFlags` specifing how white spaces should be displayed If `highlight` is `true` the current line will be highlighted. ## `highlight` whether to highlight the current line. 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. ## `enable` whether to indent a block when tab is pressed. 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 `gtk::TextBuffer`. The test-widget program (available in the `View` repository) may be useful to better understand the indentation settings (enable the space drawing!). ## `width` indent width in characters. 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 `gtk::TextBuffer` API. ## `enable` whether to insert spaces instead of tabs. Sets attributes and priority for the `category`. ## `category` the category. ## `attributes` mark attributes. ## `priority` priority of the category. Sets the position of the right margin in the given `self`. ## `pos` the width in characters where to position the right margin. If `true` line marks will be displayed beside the text. ## `show` whether line marks should be displayed. If `true` line numbers will be displayed beside the text. ## `show` whether line numbers should be displayed. If `true` a right margin is displayed. ## `show` whether to show a right margin. When set to `true`, pressing the Backspace key will try to delete spaces up to the previous tab stop. Feature: `v3_18` ## `smart_backspace` whether to enable smart Backspace handling. Set the desired movement of the cursor when HOME and END keys are pressed. ## `smart_home_end` the desired behavior among `SmartHomeEndType`. Sets the width of tabulation in characters. The `gtk::TextBuffer` still contains \t characters, but they can take a different visual width in a `View` widget. ## `width` width of tab in characters. Removes one indentation level at the beginning of the specified lines. Feature: `v3_16` ## `start` `gtk::TextIter` of the first line to indent ## `end` `gtk::TextIter` of the last line to indent Keybinding signal to change case of the text at the current cursor position. Feature: `v3_16` ## `case_type` the case to use Keybinding signal to edit a number at the current cursor position. Feature: `v3_16` ## `count` the number to add to the number at the current position Keybinding signal to join the lines currently selected. Feature: `v3_16` Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter). You can use `iter` to determine on which line the activation took place. ## `iter` a `gtk::TextIter` ## `event` the ``GdkEvent`` that activated the event The ::move-lines signal is a keybinding which gets emitted when the user initiates moving a line. The default binding key is Alt+Up/Down arrow. And moves the currently selected lines, or the current line by `count`. For the moment, only `count` of -1 or 1 is valid. The `copy` parameter is deprecated, it has never been used by `View` (the value is always `false`) and was buggy. ## `copy` `true` if the line should be copied, `false` if it should be moved. This parameter is deprecated and will be removed in a later version, it should be always `false`. ## `count` the number of lines to move over. Only 1 and -1 are supported. Keybinding signal to move the cursor to the matching bracket. Feature: `v3_16` ## `extend_selection` `true` if the move should extend the selection The ::move-words signal is a keybinding which gets emitted when the user initiates moving a word. The default binding key is Alt+Left/Right Arrow and moves the current selection, or the current word by one word. ## `count` the number of words to move over The ::show-completion signal is a key binding signal which gets emitted when the user requests a completion, by pressing ````Control````space````. This will create a `CompletionContext` with the activation type as `CompletionActivation::UserRequested`. Applications should not connect to it, but may emit it with `g_signal_emit_by_name` if they need to activate the completion by another means, for example with another key binding or a menu entry. Emitted when a the cursor was moved according to the smart home end setting. The signal is emitted after the cursor is moved, but during the `gtk::TextView`::move-cursor action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end. ## `iter` a `gtk::TextIter` ## `count` the count Draw a specific background pattern on the view. Feature: `v3_16` Draw a specific background pattern on the view. Feature: `v3_16` The completion object associated with the view Set if and how the spaces should be visualized. For a finer-grained method, there is also the `Tag`'s `Tag:draw-spaces` property. # Deprecated since 3.24 Use the `SpaceDrawer:matrix` property instead. Set if and how the spaces should be visualized. For a finer-grained method, there is also the `Tag`'s `Tag:draw-spaces` property. # Deprecated since 3.24 Use the `SpaceDrawer:matrix` property instead. Width of an indentation step expressed in number of spaces. Width of an indentation step expressed in number of spaces. Position of the right margin. Position of the right margin. Whether to display line mark pixbufs Whether to display line mark pixbufs Whether to display line numbers Whether to display line numbers Whether to display the right margin. Whether to display the right margin. Whether smart Backspace should be used. Feature: `v3_18` Whether smart Backspace should be used. Feature: `v3_18` Set the behavior of the HOME and END keys. Set the behavior of the HOME and END keys. The `SpaceDrawer` object associated with the view. Feature: `v3_24` Width of a tab character expressed in number of spaces. Width of a tab character expressed in number of spaces. the gutter position of the lines renderer the gutter position of the marks renderer