diff options
Diffstat (limited to 'doc/org.eclipse.cdt.doc.isv/reference/extension-points/org_eclipse_cdt_ui_ProposalFilter.html')
| -rw-r--r-- | doc/org.eclipse.cdt.doc.isv/reference/extension-points/org_eclipse_cdt_ui_ProposalFilter.html | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/org.eclipse.cdt.doc.isv/reference/extension-points/org_eclipse_cdt_ui_ProposalFilter.html b/doc/org.eclipse.cdt.doc.isv/reference/extension-points/org_eclipse_cdt_ui_ProposalFilter.html new file mode 100644 index 00000000000..ab0c6224b36 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.isv/reference/extension-points/org_eclipse_cdt_ui_ProposalFilter.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<HTML> +<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<title>Completion Proposal Filter</title> +<style type="text/css">@import url("../../book.css");</style> +<style type="text/css">@import url("../../schema.css");</style> +</HEAD> +<BODY> +<H1 style="text-align:center">Completion Proposal Filter</H1> +<p></p> +<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.cdt.ui.ProposalFilter<p></p> +<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>CDT 3.1 +<p></p> + +<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>When the user requests code completion for an identifier prefix then proposals are gathered from a variety of sources. It is quite common that several proposals for the same completion are gathered. After gathering it is therefore necessary to filter proposals and present them in an optimal ordering to the user. + +The notion of what is "optimal" may vary from one application to another. This extension point allows the contribution of completion filters which best suit the needs of the user in any given situation. + +The decision about which filter will actually be used remains with the user who can select his preference from a list of all contributed filters (menu Window - Preferences - C/C++ - Editor - Content Assist).<p></p> +<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6> +<p></p> +<p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.ProposalFilter">ProposalFilter</a>)></p> +<p class="code SchemaDtd"><!ATTLIST extension</p> +<p class="code SchemaDtdAttlist">point CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #IMPLIED<p class="code SchemaDtdAttlist">name CDATA #IMPLIED></p> +<p></p> +<ul class="ConfigMarkupAttlistDesc"> +</ul> +<br><p class="code SchemaDtd"><!ELEMENT <a name="e.ProposalFilter">ProposalFilter</a> EMPTY></p> +<p class="code SchemaDtd"><!ATTLIST ProposalFilter</p> +<p class="code SchemaDtdAttlist">id CDATA #REQUIRED<p class="code SchemaDtdAttlist">name CDATA #REQUIRED<p class="code SchemaDtdAttlist">class CDATA #REQUIRED></p> +<p></p> +<ul class="ConfigMarkupAttlistDesc"> +<li><b>id</b> - The required unique id of the ProposalFilter</li> +<li><b>name</b> - The required name of the ProposalFilter. This name will appear in the preferences combo and should therefore be informative for the user.</li> +<li><b>class</b> - The required fully qualified name of the implementing class which must implement org.eclipse.cdt.ui.text.contentassist.IProposalFilter</li> +</ul> +<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>See the default implementation in org.eclipse.cdt.internal.ui.text.contentassist.DefaultProposalFilter as an example. +<p></p> + +<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>ProposalFilters must implement interface <code>org.eclipse.cdt.ui.text.contentassist.IProposalFilter<code>. +<p></p> + +<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The default implementation in org.eclipse.cdt.internal.ui.text.contentassist.DefaultProposalFilter is the default filtering method which is used as long as the user preference is not changed. +<p></p> + +<br> +<p class="note SchemaCopyright"> +Copyright (c) 2006 Norbert Ploett and others. + +All rights reserved. This program and the accompanying materials +are made available under the terms of the Eclipse Public License v1.0 +which accompanies this distribution, and is available at +http://www.eclipse.org/legal/epl-v10.html + +Contributors: +Norbert Ploett (Siemens) - Initial Contribution + +</p> +</BODY> +</HTML> |