gtksourceviewmm 3.91.1
|
Main Completion Object. More...
#include <gtksourceviewmm/completion.h>
Inherits Glib::Object.
Public Member Functions | |
Completion (Completion&& src) noexcept | |
Completion& | operator= (Completion&& src) noexcept |
~Completion () noexcept override | |
GtkSourceCompletion* | gobj () |
Provides access to the underlying C GObject. | |
const GtkSourceCompletion* | gobj () const |
Provides access to the underlying C GObject. | |
GtkSourceCompletion* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
bool | add_provider (const Glib::RefPtr< CompletionProvider >& provider) |
Add a new CompletionProvider to the completion object. | |
bool | remove_provider (const Glib::RefPtr< CompletionProvider >& provider) |
Remove provider from the completion. | |
std::vector< Glib::RefPtr< CompletionProvider > > | get_providers () const |
Get list of providers registered on completion. | |
bool | start (const std::vector< Glib::RefPtr< CompletionProvider > >& providers, const Glib::RefPtr< CompletionContext >& context) |
Starts a new completion with the specified CompletionContext and a list of potential candidate providers for completion. | |
void | hide () |
Hides the completion if it is active (visible). | |
CompletionInfo* | get_info_window () |
Gets the CompletionInfo window. | |
const CompletionInfo* | get_info_window () const |
Gets the CompletionInfo window. | |
View* | get_view () |
Gets the View associated with completion. | |
const View* | get_view () const |
Gets the View associated with completion. | |
Glib::RefPtr< CompletionContext > | create_context (const Gtk::TextIter& position) |
Create a new CompletionContext for completion. | |
Glib::RefPtr< CompletionContext > | create_context () |
Create a new CompletionContext for completion. | |
void | block_interactive () |
Block interactive completion. | |
void | unblock_interactive () |
Unblock interactive completion. | |
Glib::SignalProxy< void > | signal_hide () |
Emitted when the completion window is hidden. | |
Glib::SignalProxy< void, const Glib::RefPtr< CompletionContext >& > | signal_populate_context () |
Emitted just before starting to populate the completion with providers. | |
Glib::SignalProxy< void > | signal_show () |
Emitted when the completion window is shown. | |
Glib::PropertyProxy< guint > | property_accelerators () |
Number of proposal accelerators to show. | |
Glib::PropertyProxy_ReadOnly< guint > | property_accelerators () const |
Number of proposal accelerators to show. | |
Glib::PropertyProxy< guint > | property_auto_complete_delay () |
Completion popup delay for interactive completion. | |
Glib::PropertyProxy_ReadOnly< guint > | property_auto_complete_delay () const |
Completion popup delay for interactive completion. | |
Glib::PropertyProxy< guint > | property_proposal_page_size () |
Proposal scrolling page size. | |
Glib::PropertyProxy_ReadOnly< guint > | property_proposal_page_size () const |
Proposal scrolling page size. | |
Glib::PropertyProxy< guint > | property_provider_page_size () |
Provider scrolling page size. | |
Glib::PropertyProxy_ReadOnly< guint > | property_provider_page_size () const |
Provider scrolling page size. | |
Glib::PropertyProxy< bool > | property_remember_info_visibility () |
Remember the last info window visibility state. | |
Glib::PropertyProxy_ReadOnly< bool > | property_remember_info_visibility () const |
Remember the last info window visibility state. | |
Glib::PropertyProxy< bool > | property_select_on_show () |
Select first proposal when completion is shown. | |
Glib::PropertyProxy_ReadOnly< bool > | property_select_on_show () const |
Select first proposal when completion is shown. | |
Glib::PropertyProxy< bool > | property_show_headers () |
Show provider headers when proposals from multiple providers are available. | |
Glib::PropertyProxy_ReadOnly< bool > | property_show_headers () const |
Show provider headers when proposals from multiple providers are available. | |
Glib::PropertyProxy< bool > | property_show_icons () |
Show provider and proposal icons in the completion popup. | |
Glib::PropertyProxy_ReadOnly< bool > | property_show_icons () const |
Show provider and proposal icons in the completion popup. | |
Glib::PropertyProxy_ReadOnly< View* > | property_view () const |
The GtkSourceView bound to the completion. | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
virtual void | on_hide () |
This is a default handler for the signal signal_hide(). | |
virtual void | on_populate_context (const Glib::RefPtr< CompletionContext >& context) |
This is a default handler for the signal signal_populate_context(). | |
virtual void | on_show () |
This is a default handler for the signal signal_show(). | |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gsv::Completion > | wrap (GtkSourceCompletion* object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Main Completion Object.
|
noexcept |
|
overridenoexcept |
bool Gsv::Completion::add_provider | ( | const Glib::RefPtr< CompletionProvider >& | provider | ) |
Add a new CompletionProvider to the completion object.
This will add a reference provider.
provider | A CompletionProvider. |
true
if provider was successfully added, otherwise error is thrown.void Gsv::Completion::block_interactive | ( | ) |
Block interactive completion.
This can be used to disable interactive completion when inserting or deleting text from the buffer associated with the completion. Use unblock_interactive() to enable interactive completion again.
Glib::RefPtr< CompletionContext > Gsv::Completion::create_context | ( | ) |
Create a new CompletionContext for completion.
The position at which the completion using the new context will consider completion is current cursor position.
Glib::RefPtr< CompletionContext > Gsv::Completion::create_context | ( | const Gtk::TextIter & | position | ) |
Create a new CompletionContext for completion.
The position at which the completion using the new context will consider completion can be provided by position.
position | A Gtk::TextIter. |
CompletionInfo* Gsv::Completion::get_info_window | ( | ) |
Gets the CompletionInfo window.
The info widget is the window where the completion displays optional extra information of the proposal.
const CompletionInfo* Gsv::Completion::get_info_window | ( | ) | const |
Gets the CompletionInfo window.
The info widget is the window where the completion displays optional extra information of the proposal.
std::vector< Glib::RefPtr< CompletionProvider > > Gsv::Completion::get_providers | ( | ) | const |
Get list of providers registered on completion.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
View* Gsv::Completion::get_view | ( | ) |
const View* Gsv::Completion::get_view | ( | ) | const |
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkSourceCompletion * Gsv::Completion::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void Gsv::Completion::hide | ( | ) |
Hides the completion if it is active (visible).
|
protectedvirtual |
This is a default handler for the signal signal_hide().
|
protectedvirtual |
This is a default handler for the signal signal_populate_context().
|
protectedvirtual |
This is a default handler for the signal signal_show().
|
noexcept |
Glib::PropertyProxy< guint > Gsv::Completion::property_accelerators | ( | ) |
Number of proposal accelerators to show.
Default value: 5
Glib::PropertyProxy_ReadOnly< guint > Gsv::Completion::property_accelerators | ( | ) | const |
Number of proposal accelerators to show.
Default value: 5
Glib::PropertyProxy< guint > Gsv::Completion::property_auto_complete_delay | ( | ) |
Completion popup delay for interactive completion.
Default value: 250
Glib::PropertyProxy_ReadOnly< guint > Gsv::Completion::property_auto_complete_delay | ( | ) | const |
Completion popup delay for interactive completion.
Default value: 250
Glib::PropertyProxy< guint > Gsv::Completion::property_proposal_page_size | ( | ) |
Proposal scrolling page size.
Default value: 5
Glib::PropertyProxy_ReadOnly< guint > Gsv::Completion::property_proposal_page_size | ( | ) | const |
Proposal scrolling page size.
Default value: 5
Glib::PropertyProxy< guint > Gsv::Completion::property_provider_page_size | ( | ) |
Provider scrolling page size.
Default value: 5
Glib::PropertyProxy_ReadOnly< guint > Gsv::Completion::property_provider_page_size | ( | ) | const |
Provider scrolling page size.
Default value: 5
Glib::PropertyProxy< bool > Gsv::Completion::property_remember_info_visibility | ( | ) |
Remember the last info window visibility state.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gsv::Completion::property_remember_info_visibility | ( | ) | const |
Remember the last info window visibility state.
Default value: false
Glib::PropertyProxy< bool > Gsv::Completion::property_select_on_show | ( | ) |
Select first proposal when completion is shown.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gsv::Completion::property_select_on_show | ( | ) | const |
Select first proposal when completion is shown.
Default value: true
Glib::PropertyProxy< bool > Gsv::Completion::property_show_headers | ( | ) |
Show provider headers when proposals from multiple providers are available.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gsv::Completion::property_show_headers | ( | ) | const |
Show provider headers when proposals from multiple providers are available.
Default value: true
Glib::PropertyProxy< bool > Gsv::Completion::property_show_icons | ( | ) |
Show provider and proposal icons in the completion popup.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gsv::Completion::property_show_icons | ( | ) | const |
Show provider and proposal icons in the completion popup.
Default value: true
Glib::PropertyProxy_ReadOnly< View* > Gsv::Completion::property_view | ( | ) | const |
The GtkSourceView bound to the completion.
bool Gsv::Completion::remove_provider | ( | const Glib::RefPtr< CompletionProvider >& | provider | ) |
Remove provider from the completion.
provider | A CompletionProvider. |
true
if provider was successfully removed, otherwise error is thrown.Glib::SignalProxy< void > Gsv::Completion::signal_hide | ( | ) |
Emitted when the completion window is hidden.
The default handler will actually hide the window.
void on_my_hide()
Flags: Run Last, Action
Emitted when the completion window is hidden. The default handler will actually hide the window.
Glib::SignalProxy< void, const Glib::RefPtr< CompletionContext >& > Gsv::Completion::signal_populate_context | ( | ) |
Emitted just before starting to populate the completion with providers.
You can use this signal to add additional attributes in the context.
void on_my_populate_context(const Glib::RefPtr<CompletionContext>& context)
Flags: Run Last, Action
Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context.
context | The Gtk::SourceCompletionContext for the current completion. |
Glib::SignalProxy< void > Gsv::Completion::signal_show | ( | ) |
Emitted when the completion window is shown.
The default handler will actually show the window.
void on_my_show()
Flags: Run Last, Action
Emitted when the completion window is shown. The default handler will actually show the window.
bool Gsv::Completion::start | ( | const std::vector< Glib::RefPtr< CompletionProvider > >& | providers, |
const Glib::RefPtr< CompletionContext >& | context ) |
Starts a new completion with the specified CompletionContext and a list of potential candidate providers for completion.
providers | A list of CompletionProvider. |
context | The CompletionContext with which to start the completion. |
true
if it was possible to the show completion window.void Gsv::Completion::unblock_interactive | ( | ) |
Unblock interactive completion.
This can be used after using block_interactive() to enable interactive completion again.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |