gtksourceview2-0.12.1: Binding to the GtkSourceView library.Source codeContentsIndex
Graphics.UI.Gtk.SourceView.SourceCompletionProposal
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Contents
Description
Types
Methods
Signals
Description
Synopsis
data SourceCompletionProposal
class GObjectClass o => SourceCompletionProposalClass o
sourceCompletionProposalGetLabel :: SourceCompletionProposalClass scp => scp -> IO String
sourceCompletionProposalGetMarkup :: SourceCompletionProposalClass scp => scp -> IO String
sourceCompletionProposalGetText :: SourceCompletionProposalClass scp => scp -> IO String
sourceCompletionProposalGetIcon :: SourceCompletionProposalClass scp => scp -> IO Pixbuf
sourceCompletionProposalGetInfo :: SourceCompletionProposalClass scp => scp -> IO String
sourceCompletionProposalHash :: SourceCompletionProposalClass scp => scp -> IO Int
sourceCompletionProposalEqual :: (SourceCompletionProposalClass scp1, SourceCompletionProposalClass scp2) => scp1 -> scp2 -> IO Bool
sourceCompletionProposalChanged :: SourceCompletionProposalClass scp => Signal scp (IO ())
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
show/hide Instances
class GObjectClass o => SourceCompletionProposalClass o Source
show/hide Instances
Methods
sourceCompletionProposalGetLabelSource
:: SourceCompletionProposalClass scp
=> scp
-> IO Stringreturns 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.
sourceCompletionProposalGetMarkupSource
:: SourceCompletionProposalClass scp
=> scp
-> IO Stringreturns 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.
sourceCompletionProposalGetTextSource
:: SourceCompletionProposalClass scp
=> scp
-> IO Stringreturns 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.
sourceCompletionProposalGetIconSource
:: SourceCompletionProposalClass scp
=> scp
-> IO Pixbufreturns The icon of proposal.
Gets the icon of proposal.
sourceCompletionProposalGetInfoSource
:: SourceCompletionProposalClass scp
=> scp
-> IO Stringreturns 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.
sourceCompletionProposalHashSource
:: SourceCompletionProposalClass scp
=> scp
-> IO Intreturns 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.
sourceCompletionProposalEqualSource
:: (SourceCompletionProposalClass scp1, SourceCompletionProposalClass scp2)
=> scp1
-> scp2
-> IO Boolreturns 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.
Produced by Haddock version 2.6.1