Maintainer	gtk2hs-users@lists.sourceforge.net
Stability	provisional
Portability	portable (depends on GHC)
Safe Haskell	None
Language	Haskell98

Graphics.UI.Gtk.SourceView.SourceCompletionProposal

Contents

Description
Types
Methods
Signals

Description

Synopsis

Description

The proposal interface represents a completion item in the completion window. It provides information on how to display the completion item and what action should be taken when the completion item is activated.

Types

data SourceCompletionProposal Source

Instances

Eq SourceCompletionProposal
Ord SourceCompletionProposal
GObjectClass SourceCompletionProposal
SourceCompletionProposalClass SourceCompletionProposal

class GObjectClass o => SourceCompletionProposalClass o Source

Instances

SourceCompletionProposalClass SourceCompletionProposal

Methods

sourceCompletionProposalGetLabel Source

Arguments

:: (SourceCompletionProposalClass scp, GlibString string)
=> scp
-> IO string	returns A new string containing the label of proposal.

Gets the label of proposal. 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 sourceCompletionProposalGetMarkup.

sourceCompletionProposalGetMarkup Source

Arguments

:: (SourceCompletionProposalClass scp, GlibString string)
=> scp
-> IO string	returns A new string containing the label of proposal with markup.

Gets the label of proposal with markup. The label is shown in the list of proposals and may contain markup. This will be used instead of sourceCompletionProposalGetLabel if implemented.

sourceCompletionProposalGetText Source

Arguments

:: (SourceCompletionProposalClass scp, GlibString string)
=> scp
-> IO string	returns A new string containing the text of proposal.

Gets the text of proposal. 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.

sourceCompletionProposalGetIcon Source

Arguments

:: SourceCompletionProposalClass scp
=> scp
-> IO Pixbuf	returns The icon of proposal.

Gets the icon of proposal.

sourceCompletionProposalGetInfo Source

Arguments

:: (SourceCompletionProposalClass scp, GlibString string)
=> scp
-> IO string	returns A new string containing extra information of proposal or empty if no extra information is associated to proposal.

Gets extra information associated to the proposal. This information will be used to present the user with extra, detailed information about the selected proposal.

sourceCompletionProposalHash Source

Arguments

:: SourceCompletionProposalClass scp
=> scp
-> IO Int	returns The hash value of proposal

Get the hash value of proposal. This is used to (together with sourceCompletionProposalEqual) to match proposals in the completion model.

sourceCompletionProposalEqual Source

Arguments

:: (SourceCompletionProposalClass scp1, SourceCompletionProposalClass scp2)
=> scp1
-> scp2
-> IO Bool	returns `True` if proposal and object are the same proposal

Get whether two proposal objects are the same. This is used to (together with sourceCompletionProposalHash) to match proposals in the completion model.

Signals

sourceCompletionProposalChanged :: SourceCompletionProposalClass scp => Signal scp (IO ()) Source

Emitted when the proposal has changed. The completion popup will react to this by updating the shown information.