gtksourceview::SourceCompletion Class Reference

Inherits Gtk::Object.

Collaboration diagram for gtksourceview::SourceCompletion:

[legend]

List of all members.

Public Member Functions
virtual	~SourceCompletion ()
GtkSourceCompletion*	gobj ()
	Provides access to the underlying C GtkObject.
const GtkSourceCompletion*	gobj () const
	Provides access to the underlying C GtkObject.
bool	add_provider (const Glib::RefPtr< SourceCompletionProvider >& provider)
	Add a new Gtk::SourceCompletionProvider to the completion object.
bool	remove_provider (const Glib::RefPtr< SourceCompletionProvider >& provider)
	Remove provider from the completion.
Glib::ListHandle< Glib::RefPtr < SourceCompletionProvider > >	get_providers () const
	Get list of providers registered on completion.
bool	show (const Glib::ListHandle< Glib::RefPtr< SourceCompletionProvider > >& providers, const Glib::RefPtr< SourceCompletionContext >& context)
	Starts a new completion with the specified Gtk::SourceCompletionContext and a list of potential candidate providers for completion.
void	hide ()
	Hides the completion if it is active (visible).
SourceCompletionInfo*	get_info_window () const
	The info widget is the window where the completion displays optional extra information of the proposal.
SourceView*	get_view () const
	The Gtk::SourceView associated with completion.
Glib::RefPtr < SourceCompletionContext >	create_context (const Gtk::TextIter& position)
	Create a new Gtk::SourceCompletionContext for completion.
Glib::RefPtr < SourceCompletionContext >	create_context ()
void	move_window (const Gtk::TextIter& position)
	Move the completion window to a specific iter.
void	block_interactive ()
	Block interactive completion.
void	unblock_interactive ()
	Unblock interactive completion.
Glib::SignalProxy0< void >	signal_hide ()
Glib::SignalProxy1< void, const Glib::RefPtr < SourceCompletionContext >& >	signal_populate_context ()
Glib::SignalProxy0< void >	signal_show ()
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 < SourceView* >	property_view () const
	The GtkSourceView bound to the completion.
Protected Member Functions
virtual void	on_hide ()
virtual void	on_populate_context (const Glib::RefPtr< SourceCompletionContext >& context)
virtual void	on_show ()
Related Functions
(Note that these are not member functions.)
gtksourceview::SourceCompletion*	wrap (GtkSourceCompletion* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Constructor & Destructor Documentation

virtual gtksourceview::SourceCompletion::~SourceCompletion

(

)

[virtual]

---

Member Function Documentation

bool gtksourceview::SourceCompletion::add_provider

(

const Glib::RefPtr< SourceCompletionProvider >&

provider

)

Add a new Gtk::SourceCompletionProvider to the completion object.

This will add a reference provider, so make sure to unref your own copy when you no longer need it.

Parameters:

provider

A Gtk::SourceCompletionProvider.

Returns:

true if provider was successfully added, otherwise if error is provided, it will be set with the error and false is returned.

void gtksourceview::SourceCompletion::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 gtk_source_completion_unblock_interactive to enable interactive completion again.

Glib::RefPtr<SourceCompletionContext> gtksourceview::SourceCompletion::create_context

(

)

Glib::RefPtr<SourceCompletionContext> gtksourceview::SourceCompletion::create_context

(

const Gtk::TextIter &

position

)

Create a new Gtk::SourceCompletionContext for completion.

The position at which the completion using the new context will consider completion can be provider by position. If position is 0, the current cursor position will be used.

Parameters:

position

A Gtk::TextIter.

Returns:

A new Gtk::SourceCompletionContext. The reference being returned is a 'floating' reference, so if you invoke gtk_source_completion_show with this context you don't need to unref it.

SourceCompletionInfo* gtksourceview::SourceCompletion::get_info_window

(

)

const

The info widget is the window where the completion displays optional extra information of the proposal.

Returns:

The Gtk::SourceCompletionInfo window.

Glib::ListHandle<Glib::RefPtr<SourceCompletionProvider> > gtksourceview::SourceCompletion::get_providers

(

)

const

Get list of providers registered on completion.

The returned list is owned by the completion and should not be freed.

Returns:

List of Gtk::SourceCompletionProvider.

SourceView* gtksourceview::SourceCompletion::get_view

(

)

const

The Gtk::SourceView associated with completion.

Returns:

The Gtk::SourceView associated with completion.

const GtkSourceCompletion* gtksourceview::SourceCompletion::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Object.

GtkSourceCompletion* gtksourceview::SourceCompletion::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Object.

void gtksourceview::SourceCompletion::hide

(

)

Hides the completion if it is active (visible).

void gtksourceview::SourceCompletion::move_window

(

const Gtk::TextIter &

position

)

Move the completion window to a specific iter.

Parameters:

iter

A Gtk::TextIter.

virtual void gtksourceview::SourceCompletion::on_hide

(

)

[protected, virtual]

virtual void gtksourceview::SourceCompletion::on_populate_context

(

const Glib::RefPtr< SourceCompletionContext >&

context

)

[protected, virtual]

virtual void gtksourceview::SourceCompletion::on_show

(

)

[protected, virtual]

Glib::PropertyProxy_ReadOnly<guint> gtksourceview::SourceCompletion::property_accelerators

(

)

const

Number of proposal accelerators to show.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<guint> gtksourceview::SourceCompletion::property_accelerators

(

)

Number of proposal accelerators to show.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<guint> gtksourceview::SourceCompletion::property_auto_complete_delay

(

)

const

Completion popup delay for interactive completion.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<guint> gtksourceview::SourceCompletion::property_auto_complete_delay

(

)

Completion popup delay for interactive completion.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<guint> gtksourceview::SourceCompletion::property_proposal_page_size

(

)

const

Proposal scrolling page size.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<guint> gtksourceview::SourceCompletion::property_proposal_page_size

(

)

Proposal scrolling page size.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<guint> gtksourceview::SourceCompletion::property_provider_page_size

(

)

const

Provider scrolling page size.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<guint> gtksourceview::SourceCompletion::property_provider_page_size

(

)

Provider scrolling page size.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceCompletion::property_remember_info_visibility

(

)

const

Remember the last info window visibility state.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> gtksourceview::SourceCompletion::property_remember_info_visibility

(

)

Remember the last info window visibility state.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceCompletion::property_select_on_show

(

)

const

Select first proposal when completion is shown.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> gtksourceview::SourceCompletion::property_select_on_show

(

)

Select first proposal when completion is shown.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceCompletion::property_show_headers

(

)

const

Show provider headers when proposals from multiple providers are available.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> gtksourceview::SourceCompletion::property_show_headers

(

)

Show provider headers when proposals from multiple providers are available.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceCompletion::property_show_icons

(

)

const

Show provider and proposal icons in the completion popup.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> gtksourceview::SourceCompletion::property_show_icons

(

)

Show provider and proposal icons in the completion popup.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<SourceView*> gtksourceview::SourceCompletion::property_view

(

)

const

The GtkSourceView bound to the completion.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

bool gtksourceview::SourceCompletion::remove_provider

(

const Glib::RefPtr< SourceCompletionProvider >&

provider

)

Remove provider from the completion.

Parameters:

provider

A Gtk::SourceCompletionProvider.

Returns:

true if provider was successfully removed, otherwise if error is provided, it will be set with the error and false is returned.

bool gtksourceview::SourceCompletion::show	(	const Glib::ListHandle< Glib::RefPtr< SourceCompletionProvider > >&	providers,
		const Glib::RefPtr< SourceCompletionContext >&	context
	)

Starts a new completion with the specified Gtk::SourceCompletionContext and a list of potential candidate providers for completion.

Parameters:

	providers	A list of Gtk::SourceCompletionProvider or 0.
	context	The Gtk::SourceCompletionContext with which to start the completion.

Returns:

true if it was possible to the show completion window.

Glib::SignalProxy0< void > gtksourceview::SourceCompletion::signal_hide

(

)

Prototype:

void on_my_hide()

Glib::SignalProxy1< void,const Glib::RefPtr<SourceCompletionContext>& > gtksourceview::SourceCompletion::signal_populate_context

(

)

Prototype:

void on_my_populate_context(const Glib::RefPtr<SourceCompletionContext>& context)

Glib::SignalProxy0< void > gtksourceview::SourceCompletion::signal_show

(

)

Prototype:

void on_my_show()

void gtksourceview::SourceCompletion::unblock_interactive

(

)

Unblock interactive completion.

This can be used after using gtk_source_completion_block_interactive to enable interactive completion again.

---

Friends And Related Function Documentation

gtksourceview::SourceCompletion* wrap	(	GtkSourceCompletion *	object,
		bool	take_copy = false
	)			[related]

A Glib::wrap() method for this object.

Parameters:

	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.

Returns:

A C++ instance that wraps this C instance.

---

The documentation for this class was generated from the following file:

• gtksourceviewmm/sourcecompletion.h