mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-06 01:06:01 +02:00
Code Issues Wiki Activity

From Dave Williams: Added in screen captures and updated material for C/C++ Editor, Content Assist and Search dialog boxes.

Browse source
This commit is contained in:
David Daoust 2004-04-12 14:53:37 +00:00
parent f9a68a8761
commit 54490364bb
15 changed files with 105 additions and 106 deletions

BIN
doc/org.eclipse.cdt.doc.user/images/Idea.jpg Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 5 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/code_templates.png Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 28 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/contentAssist_example.gif Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 22 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/contentAssist_preferences.png Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 22 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/editor_annotations_preferences.png Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 22 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/editor_color_preferences.png Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 26 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/editor_general_preferences.png Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 21 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/search.png Normal file
View file

Binary file not shown.
Side by side

After

(image error) Size: 12 KiB

37
doc/org.eclipse.cdt.doc.user/reference/cdt_o_ceditor_pref.htm
View file

@ -2,54 +2,49 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>C/C++ editor, code templates and search preferences</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>C/C++ editor, code templates and search preferences</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<body> <body>
<h1>C/C++ editor, code templates and search preferences</h1> <h1>C/C++ editor, code template, and search preferences</h1>
<p>This section describes the preferences pages for the C/C++ editor, code <p>This section describes how to set preferences for the C/C++ editor, code
templates and search features.</p> templates, and the search feature.</p>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="508"> <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="508">
<tr> <tr>
<th align="left" valign="bottom" width="244">To learn about</th> <th align="left" valign="bottom" width="244">To change preferences for</th>
<th align="left" width="241">See</th> <th align="left" width="241">See</th>
</tr> </tr>
<tr> <tr>
<td align="left" width="244">General C/C++ editor preferences</td> <td align="left" width="244">C/C++ editor</td>
<td align="left" width="241"><a href="cdt_u_c_editor_gen.htm">General page, <td align="left" width="241"><a href="cdt_u_c_editor_gen.htm">General page, Preferences window</a></td>
Preferences window</a></td>
</tr> </tr>
<tr> <tr>
<td align="left" width="244">C/C++ editor annotations preferences</td> <td align="left" width="244">C/C++ editor annotations</td>
<td align="left" width="241"><a href="cdt_u_c_editor_anno.htm">Annotations <td align="left" width="241"><a href="cdt_u_c_editor_anno.htm">Annotations page, Preferences window</a></td>
page, Preferences window</a></td>
</tr> </tr>
<tr> <tr>
<td align="left" width="244">C/C++ editor text color preferences</td> <td align="left" width="244">C/C++ editor text color</td>
<td align="left" width="241"><a href="cdt_u_c_editor_color.htm">Colors page, <td align="left" width="241"><a href="cdt_u_c_editor_color.htm">Colors page,
Preferences window</a></td> Preferences window</a></td>
</tr> </tr>
<tr> <tr>
<td align="left" width="244">C/C++ editor preference Content Assist <td align="left" width="244">C/C++ editor Content Assist Feature</td>
preferences</td>
<td align="left" width="241"><a href="cdt_u_c_editor_con_assist.htm">Content <td align="left" width="241"><a href="cdt_u_c_editor_con_assist.htm">Content
Assist page, Preferences window</a></td> Assist page, Preferences window</a></td>
</tr> </tr>
<tr> <tr>
<td align="left" width="244">C/C++ editor Code Templates preferences</td> <td align="left" width="244">C/C++ editor code template</td>
<td align="left" width="241"><a href="cdt_u_code_temp.htm">Code Templates <td align="left" width="241"><a href="cdt_u_code_temp.htm">Code Templates
page, Preferences window</a></td> page, Preferences window</a></td>
</tr> </tr>
<tr> <tr>
<td align="left" width="244">C/C++ editor Search preferences</td> <td align="left" width="244">C/C++ editor search feature</td>
<td align="left" width="241"><a href="cdt_u_search.htm">C/C++ search page, <td align="left" width="241"><a href="cdt_u_search.htm">C/C++ search page,
Search dialog box</a></td> Search dialog box</a></td>
</tr> </tr>

21
doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_anno.htm
View file

@ -2,12 +2,10 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>Annotations page, Preferences window</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>Annotations page, Preferences window</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<!--INFOPOP <!--INFOPOP
Customize the appearance of the C/C++ Editor. Customize the appearance of the C/C++ Editor.
@ -16,19 +14,18 @@ END INFOPOP-->
<h1>Annotations page, Preferences window</h1> <h1>Annotations page, Preferences window</h1>
<p>The Annotations page of the Preferences window lets you customize the <p>You can customize the appearance of annotations in the C/C++ editor on the Annotations page of the Preferences Window.</p>
appearance of annotations in the C/C++ editor.</p> <p><img src="../images/editor_annotations_preferences.png" border="0" width="670" height="607" alt="Editor Annotations Preferences Dialog Box"></p>
<dl> <dl>
<dt>Annotation Presentation Options</dt> <dt>Annotation Presentation Options</dt>
<dd>Lists items that can be displayed in a specified color.</dd> <dd>Lists items, such as breakpoints, bookmarks, or index markers, for which you can specify a color.</dd>
<dt>Show in Text</dt> <dt>Show in Text</dt>
<dd>Displays the selected annotation type in the text. The <dd>Displays in the text the selected type of annotation. The corresponding text is underlined.</dd>
corresponding text is underlined.</dd>
<dt>Show in Overview Ruler</dt> <dt>Show in Overview Ruler</dt>
<dd>Displays the selected annotation type in the overview ruler.</dd> <dd>Displays the selected annotation type in the overview ruler.</dd>
<dt>Annotations Color</dt> <dt>Annotations Color</dt>
<dd>Specifies the color in which to display an annotation.</dd> <dd>Specifies the color in which to display the selected item.</dd>
</dl> </dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>

19
doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_color.htm
View file

@ -2,12 +2,10 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>Colors page, Preferences window</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>Colors page, Preferences window</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<!--INFOPOP <!--INFOPOP
@ -17,19 +15,20 @@ END INFOPOP-->
<h1>Colors page, Preferences window</h1> <h1>Colors page, Preferences window</h1>
<p>The Colors page of the Preferences window lets you customize the appearance of the C/C++ editor.</p> <p>You can customize the appearance of the C/C++ editor on the Colors page of the Preferences window.</p>
<p><img src="../images/editor_color_preferences.png" border="0" width="670" height="607" alt="Editor Color Preferences Dialog Box"></p>
<dl> <dl>
<dt>System Default</dt> <dt>System Default</dt>
<dd>Uses the system default background color.</dd> <dd>Uses the system default for the background color.</dd>
<dt>Custom</dt> <dt>Custom</dt>
<dd>Changes the background color.</dd> <dd>Changes the background color.</dd>
<dt>Foreground</dt> <dt>Foreground</dt>
<dd>Lists items that can be displayed in a specified color.</dd> <dd>Lists items, such as comments, keywords, and strings, for which you can specify a color.</dd>
<dt>Color</dt> <dt>Color</dt>
<dd>Specifies the color in which to display the selected item.</dd> <dd>Specifies the color in which to display the selected item.</dd>
<dt>Bold</dt> <dt>Bold</dt>
<dd>Bolds the selected item.</dd> <dd>Makes the selected item bold.</dd>
</dl> </dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>

56
doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_con_assist.htm
View file

@ -2,12 +2,10 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>Content Assist page, Preferences window</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>Content Assist page, Preferences window</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<!--INFOPOP <!--INFOPOP
Customize how the Content Assist feature works. Customize how the Content Assist feature works.
@ -16,24 +14,38 @@ END INFOPOP-->
<h1>Content Assist page, Preferences window</h1> <h1>Content Assist page, Preferences window</h1>
<p>The Contents Assist page of the Preferences window, lets you customize how the Content Assist feature works.</p> <p>You can customize the Content Assist feature on the Contents Assist page of the C/C++ Editor Preferences window. To change the Content Assist preferences click
<b>Window &gt; Preferences &gt; C/C++ &gt; C++ Editor &gt; Content Assist.</b></p>
<p>
<img src="../images/contentAssist_preferences.png" border="0" width="667" height="525" alt="Content Assist Preferences Dialog Box">
</p>
<dl> <dl>
<dt>Insert single proposals automatically</dt> <p><dt>Search scope for completion proposals</dt>
<dd>Inserts an element into your code when it is the only item in the Content Assist <dd>You can configure the Content Assist feature to select proposals from items contained only in the current file and included files, or from the current project.</dd>
list.</dd>
<dt>Enable auto activation</dt> <p><dt>Insert single proposals automatically</dt>
<dd>Opens Content Assist when you type the first letter <dd>Inserts an element into your code when the Content Assist feature finds only one proposal.</dd>
of an element in the C/C++ editor for which there is a code template or an
element that begins with the same letter.</dd> <p><dt>Present proposals in alphabetical order</dt>
<dt>Auto activation delay</dt> <dd>Proposals, by default, appear in order of relevance determined by context, scope and prefix. Alternatively, you can configure the Content Assist feature to order its proposals alphabetically.</dd>
<dd>Specifies the number of seconds before Content Assist is
activated.</dd> <p><dt>Content Assist parsing timeout (in milliseconds)
<dt>Auto activation triggers for C:</dt> <dd>For very large projects, the Content Assist feature might slow the response of the plugin as the Content Assist feature searches the project for proposals. This setting stops the Content Assist search when it reaches the specified threshold.<dd>
<dd>Specifies a character that, if typed in the C/C++ editor, causes code assist to
be invoked immediately&nbsp; before the delay times out.</dd> <p><dt>Auto activation</dt>
<dt>Background for completion proposals</dt> <dd>Certain predefined triggers force the Content Assist feature to activate. You can disable the predefined triggers with these checkboxes.
<dd>Specifies the background color for the Content Assist dialog box.</dd>
<p><dt>Auto activation delay</dt>
<dd>Specifies the number of milliseconds before Content Assist is activated.</dd>
<p><dt>Background for completion proposals</dt>
<dd>Specifies the background color of the Content Assist dialog box.</dd>
<p><dt>Foreground for completion proposals</dt>
<dd>Specifies the foreground color of the Content Assist dialog box.</dd>
</dl> </dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>

33
doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_gen.htm
View file

@ -2,12 +2,10 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>General page, Preferences window</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>General page, Preferences window</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<!--INFOPOP <!--INFOPOP
@ -17,18 +15,21 @@ END INFOPOP-->
<h1>General page, Preferences window</h1> <h1>General page, Preferences window</h1>
<p>The General page of the Preferences window lets you customize the appearance of the C/C++ editor.</p> <p>You can customize the appearance of the C/C++ editor on the General page of the Preferences window.</p>
<p><img src="../images/editor_general_preferences.png" border="0" width="670" height="607" alt="Editor General Preferences Dialog Box"></p>
<dl> <dl>
<dt>Text Font</dt>
<dd>Changes the font of the text in the workbench.</dd>
<dt>Displayed tab width</dt> <dt>Displayed tab width</dt>
<dd>Specifies the tab width as a number of characters. For example <b>4</b>, <dd>Specifies the width of the tab as a number of characters. For example a value of <b>4</b>,
means the tab width will be 4 characters wide.</dd> means that the tab width is 4-characters wide.</dd>
<dt>Print margin column</dt> <dt>Print margin column</dt>
<dd>Specifies the print margin width as a number of characters.</dd> <dd>Specifies the width of the print margin as a number of characters. For example a value of
<b>80</b> means that the print area is 80-characters wide.</dd>
<dt>Insert space for tabs</dt> <dt>Insert space for tabs</dt>
<dd>Inserts spaces instead of a tab character when your press <b>Tab</b>.</dd> <dd>Inserts a space instead of a tab character when you press <tt>Tab</tt>.</dd>
<dt>Highlight matching brackets</dt> <dt>Highlight matching brackets</dt>
<dd>Highlights matching brackets.</dd> <dd>When the cursor is beside a bracket, the matching bracket is highlighted.</dd>
<dt>Show line numbers</dt> <dt>Show line numbers</dt>
<dd>Displays line numbers in the left margin.</dd> <dd>Displays line numbers in the left margin.</dd>
<dt>Highlight current line</dt> <dt>Highlight current line</dt>
@ -36,11 +37,11 @@ END INFOPOP-->
<dt>Show overview ruler</dt> <dt>Show overview ruler</dt>
<dd>Displays the overview ruler on the right margin.</dd> <dd>Displays the overview ruler on the right margin.</dd>
<dt>Show print margin</dt> <dt>Show print margin</dt>
<dd>Displays the print margin.</dd> <dd>Displays the print margin in the editor.</dd>
<dt>Appearance color options</dt> <dt>Appearance color options</dt>
<dd>Lists items that can be displayed in a specified color.</dd> <dd>Lists the items for which you can specify a color.</dd>
<dt>Color</dt> <dt>Color</dt>
<dd>Changes the color of the item selected in the list.</dd> <dd>Changes the color of the item that is selected in the list.</dd>
</dl> </dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>

24
doc/org.eclipse.cdt.doc.user/reference/cdt_u_code_temp.htm
View file

@ -2,12 +2,10 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>Code Templates page, Preferences window</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>Code Templates page, Preferences window</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<!--INFOPOP <!--INFOPOP
Create, edit, remove, import, or export code templates. Create, edit, remove, import, or export code templates.
@ -17,14 +15,16 @@ END INFOPOP-->
<h1>Code Templates page, Preferences window</h1> <h1>Code Templates page, Preferences window</h1>
<p>The Code Templates page of the Preferences window lets you create, edit <p>You can manipulate any of the common code templates that are predefined within the CDT. To modify, delete, export,
import and export code templates.</p> import, or create your own templates click <b>Window &gt; Preferences &gt; C/C++ &gt; Code Templates</b>.</p>
<img src="../images/code_templates.png" border="0" width="737" height="539" alt="Code Templates Dialog Box">
<dl> <dl>
<dt>New</dt> <dt>New</dt>
<dd>Creates a new code template.</dd> <dd>Creates a new code template.</dd>
<dt>Edit</dt> <dt>Edit</dt>
<dd>Edits the code template selected in the list.</dd> <dd>Edits the code template that is selected in the list.</dd>
<dt>Remove</dt> <dt>Remove</dt>
<dd>Removes the selected code templates from the list.</dd> <dd>Removes the selected code templates from the list.</dd>
<dt>Import</dt> <dt>Import</dt>
@ -34,11 +34,9 @@ import and export code templates.</p>
<dt>Export All</dt> <dt>Export All</dt>
<dd>Exports all templates in the list.</dd> <dd>Exports all templates in the list.</dd>
<dt>Enable All</dt> <dt>Enable All</dt>
<dd>Makes all templates available when the Content Assist feature is <dd>Makes all templates available when you invoke the Content Assist feature.</dd>
invoked.</dd>
<dt>Disable All</dt> <dt>Disable All</dt>
<dd>Makes all templates unavailable when the Content Assist feature is <dd>Makes all templates unavailable when you invoke the Content Assist feature. </dd>
invoked. </dd>
</dl> </dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>

21
doc/org.eclipse.cdt.doc.user/reference/cdt_u_search.htm
View file

@ -2,12 +2,10 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="ProgId" content="FrontPage.Editor.Document"> <title>C/C++ search page, Search dialog box</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../help.css">
<title>C/C++ search page, Search dialog box</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head> </head>
<!--INFOPOP <!--INFOPOP
Search for C/C++ elements. Search for C/C++ elements.
@ -16,9 +14,8 @@ END INFOPOP-->
<h1>C/C++ search page, Search dialog box</h1> <h1>C/C++ search page, Search dialog box</h1>
<p>The C/C++ search page of the Search dialog box lets you search for C/C++ <p>You can search for C/C++ elements on the C/C++ search page of the Search dialog box.</p>
elements.</p> <p><img src="../images/search.png" border="0" width="512" height="394" alt="Search Dialog Box"></p>
<dl> <dl>
<dt>Search string</dt> <dt>Search string</dt>
<dd>Specifies a search string.</dd> <dd>Specifies a search string.</dd>
@ -29,7 +26,7 @@ elements.</p>
(functions that are not members of a class, struct, or union).</dd> (functions that are not members of a class, struct, or union).</dd>
<dt>Variable</dt> <dt>Variable</dt>
<dd>Searches for variables that are not members of a class, <dd>Searches for variables that are not members of a class,
struct or union.</dd> struct, or union.</dd>
<dt>Union</dt> <dt>Union</dt>
<dd>Searches for unions.</dd> <dd>Searches for unions.</dd>
<dt>Method</dt> <dt>Method</dt>
@ -48,14 +45,14 @@ elements.</p>
<dd>Limits the search to declarations.</dd> <dd>Limits the search to declarations.</dd>
<dt>Definitions</dt> <dt>Definitions</dt>
<dd>Limits the search to definitions (for functions, methods, <dd>Limits the search to definitions (for functions, methods,
variables and fields).</dd> variables, and fields).</dd>
<dt>References</dt> <dt>References</dt>
<dd>Limits the search to references.</dd> <dd>Limits the search to references.</dd>
<dt>All Occurrences</dt> <dt>All Occurrences</dt>
<dd>Includes declarations, definitions, and references in the <dd>Includes declarations, definitions, and references in the
search.</dd> search.</dd>
<dt>Workspace</dt> <dt>Workspace</dt>
<dd>Searches the eclipse workspace.</dd> <dd>Searches the Eclipse workspace.</dd>
<dt>Selected Resources</dt> <dt>Selected Resources</dt>
<dd>Includes selected resources in the search.</dd> <dd>Includes selected resources in the search.</dd>
<dt>Working Set</dt> <dt>Working Set</dt>