PageRenderTime 68ms CodeModel.GetById 1ms RepoModel.GetById 1ms app.codeStats 0ms

/tags/SN-513-2003-04-09/snavigator/doc/html/edk/userguide/clbrws.html

https://gitlab.com/OpenSourceMirror/sourcenav
HTML | 209 lines | 209 code | 0 blank | 0 comment | 0 complexity | 931d35360fca1bbbfae2813e5c513371 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"><HTML>
    2. 

  2. <HEAD>
    3. 

  3. <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
    4. 

  4. <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
    5. 

  5. <META NAME="GENERATOR" CONTENT="Adobe FrameMaker 5.5/HTML Export Filter">
    6. 

  6. <LINK REL="STYLESHEET" HREF="../cygnus1.css" CHARSET="ISO-8859-1" TYPE="text/css">
    7. 

  7. <TITLE>Class Browser</TITLE>
    8. 

  8. </HEAD>
    9. 

  9. <BODY BGCOLOR="#ffffff">
    10. 

  10. <DIV>
    11. 

  11. <TABLE CLASS="TABLE" WIDTH="100" BORDER="0" ALIGN="center" CELLPADDING="1">
    12. 

  12. <TR>
    13. 

  13. <TH COLSPAN="3" ALIGN="center">
    14. 

  14. <P CLASS="Gotos">
    15. 

  15. </P>
    16. 

  16. </TH></TR>
    17. 

  17. <TR><TD ALIGN="center">
    18. 

  18. <P CLASS="Gotos"><A HREF="index_ug.html">Contents</A>
    19. 

  19. </P></TD>
    20. 

  20. <TD ALIGN="center">
    21. 

  21. <P CLASS="Gotos"><A HREF="clhierbrws.html">Previous</A></P></TD>
    22. 

  22. <TD ALIGN="center">
    23. 

  23. <P CLASS="Gotos">
    24. 

  24. <A HREF="crossref.html">Next</A></P></TD>
    25. 

  25. </TR></TABLE><HR ALIGN="center">
    26. 

  26. </DIV>
    27. 

  27. <TABLE>
    28. 

  28. <TR>
    29. 

  29. <TD ROWSPAN="1" COLSPAN="1">
    30. 

  30. </TD>
    31. 

  31. </TR>
    32. 

  32. </TABLE>
    33. 

  33. <H1 CLASS="ChapterTitle">
    34. 

  34. <A NAME="pgfId-997886"></A><BR>
    35. 

  35. <A NAME="38835"></A>Class Browser&nbsp;&nbsp;<IMG SRC="clbrws-1.gif">
    36. 

  36. <DIV>
    37. 

  37. <IMG SRC="clbrws-2.gif">
    38. 

  38. </DIV>
    39. 

  39. </H1>
    40. 

  40. <P CLASS="Body">
    41. 

  41. <A NAME="pgfId-1001771"></A>For projects developed using object-oriented languages, 
    42. 

  42. the <A NAME="marker-1001770"></A><SPAN CLASS="Bold">
    43. 

  43. Class Browser</SPAN>
    44. 

  44.  enables you to browse class hierarchies, access levels, and member types. 
    45. 

  45. The <SPAN CLASS="Bold">
    46. 

  46. Class Browser</SPAN>
    47. 

  47.  displays the list of class members of a particular class, based on your 
    48. 

  48. selections from the <SPAN CLASS="Bold">
    49. 

  49. Class/Hierarchy</SPAN>
    50. 

  50.  tab of the <SPAN CLASS="Bold">
    51. 

  51. Preferences</SPAN>
    52. 

  52.  dialog (see <A HREF="clhierbrws.html#29305" CLASS="XRef">Class/Hierarchy Preferences</A>). </P>
    53. 

  53. <P CLASS="Body">
    54. 

  54. <A NAME="pgfId-1046282"></A>For traditional languages such as C, COBOL, and FORTRAN, 
    55. 

  55. the <SPAN CLASS="Bold">
    56. 

  56. Class Browser</SPAN>
    57. 

  57.  enables you to see the members of structures and common blocks.</P>
    58. 

  58. <H3 CLASS="Label">Note</H3>
    59. 

  59. <P CLASS="Note">Source-Navigator treats structures, classes, and common blocks in
    60. 

  60. the same way. The only difference is that classes have inheritance and the others
    61. 

  61. do not.</P>
    62. 

  62. <H2 CLASS="Heading1">
    63. 

  63. <A NAME="pgfId-1091985"></A>Using the Class Browser</H2>
    64. 

  64. <P CLASS="Body">
    65. 

  65. <A NAME="pgfId-1091991"></A>Start the <A NAME="marker-1091990"></A><SPAN CLASS="Bold">
    66. 

  66. Class Browser</SPAN>
    67. 

  67.  in one of the following ways:</P>
    68. 

  68. <UL>
    69. 

  69. <LI CLASS="Bullet"><P CLASS="Body">
    70. 

  70. <A NAME="pgfId-1158604"></A>double-click on a class.</LI>
    71. 

  71. <LI CLASS="Bullet"><P CLASS="Body">
    72. 

  72. <A NAME="pgfId-1158605"></A>select a class and click the <SPAN CLASS="Bold">
    73. 

  73. Class Browser</SPAN><P CLASS="Body">
    74. 

  74.  toolbar button (see <A HREF="symbrws.html#20717" CLASS="XRef">Class Browser button</A>).</LI>
    75. 

  75. <LI CLASS="Bullet"><P CLASS="Body">
    76. 

  76. <A NAME="pgfId-1158606"></A>from the <SPAN CLASS="Bold">
    77. 

  77. Windows</SPAN>
    78. 

  78.  menu, select <SPAN CLASS="Bold">
    79. 

  79. New View </SPAN>
    80. 

  80. <EM CLASS="Arrow">-></EM><SPAN CLASS="Bold">
    81. 

  81.  Class</SPAN>.</LI>
    82. 

  82. <LI CLASS="Bullet"><P CLASS="Body">
    83. 

  83. <A NAME="pgfId-1158607"></A>choose the <SPAN CLASS="Bold">
    84. 

  84. Class</SPAN>
    85. 

  85.  tab in the <SPAN CLASS="Bold">
    86. 

  86. Editor</SPAN>.</LI>
    87. 

  87. </UL>
    88. 

  88. <P CLASS="FigureTitle">
    89. 

  89. <A NAME="pgfId-1046411"></A><A NAME="marker-1046357"></A>Class Browser Window </P>
    90. 

  90. <DIV>
    91. 

  91. <IMG SRC="clbrws-3.gif">
    92. 

  92. </DIV>
    93. 

  93. <H3 CLASS="Heading2">
    94. 

  94. <A NAME="pgfId-996794"></A> Class Name</H3>
    95. 

  95. <P CLASS="Body">
    96. 

  96. <A NAME="pgfId-996795"></A>You can enter the <A NAME="marker-999609"></A>class name into the <SPAN CLASS="Bold">
    97. 

  97. Symbol Accelerator </SPAN>
    98. 

  98. combo-box (<A NAME="marker-1165108"></A>emacs-style tab completion is also supported). If you press the <SPAN CLASS="Bold">
    99. 

  99. Enter</SPAN>
    100. 

  100.  key and the name matches a valid class name, the information for the appropriate class is loaded.</P>
    101. 

  101. <H3 CLASS="Heading2">
    102. 

  102. <A NAME="pgfId-996797"></A>Member List</H3>
    103. 

  103. <P CLASS="Body">
    104. 

  104. <A NAME="pgfId-996798"></A>The symbols displayed in the member list are controlled by the pulldown menus and inheritance tree. Access levels and attributes are indicated by icons; for the key to these icons select <SPAN CLASS="Bold">
    105. 

  105. Abbreviations</SPAN>
    106. 

  106.  from the <SPAN CLASS="Bold">
    107. 

  107. Help </SPAN>
    108. 

  108. menu, or see <A HREF="usingsn.html#16890" CLASS="XRef">Abbreviations Panel</A>.</P>
    109. 

  109. <H3 CLASS="Heading2">
    110. 

  110. <A NAME="pgfId-996808"></A>Inheritance Tree</H3>
    111. 

  111. <P CLASS="Body">
    112. 

  112. <A NAME="pgfId-996809"></A>The <A NAME="marker-997418"></A>inheritance tree shows the relationship of the browsed class and its baseclasses. </P>
    113. 

  113. <DIV>
    114. 

  114. <IMG SRC="clbrws-4.gif">
    115. 

  115. </DIV>
    116. 

  116. <P CLASS="Body">
    117. 

  117. <A NAME="pgfId-1002666"></A>The check boxes before the class names determine whether or not members of a class are included in the member list. Use the mouse to manipulate these check boxes:</P>
    118. 

  118. <P CLASS="BodyHang1">
    119. 

  119. <A NAME="pgfId-996810"></A><B>Click</B><BR>
    120. 

  120. Toggles the check box.</P>
    121. 

  121. <P CLASS="BodyHang1">
    122. 

  122. <A NAME="pgfId-996811"></A><B>Ctrl+click</B><BR>
    123. 

  123. Includes only the members of the selected class.</P>
    124. 

  124. <P CLASS="BodyHang1">
    125. 

  125. <A NAME="pgfId-996812"></A><B>Double-click</B><BR>
    126. 

  126. Starts the <SPAN CLASS="Bold">
    127. 

  127. Editor</SPAN>, which displays the source file.</P>
    128. 

  128. <P CLASS="BodyHang1">
    129. 

  129. <A NAME="pgfId-996813"></A><B>Right-click</B><BR>
    130. 

  130. Displays a menu in which you may select one or all classes.</P>
    131. 

  131. <H3 CLASS="Heading2">
    132. 

  132. <A NAME="pgfId-996826"></A>Member List Filter Dialog</H3>
    133. 

  133. <P CLASS="Body">
    134. 

  134. <A NAME="pgfId-1002728"></A>Click on the <SPAN CLASS="Bold">
    135. 

  135. Filter</SPAN>
    136. 

  136.  button to bring up the <SPAN CLASS="Bold">
    137. 

  137. Filter</SPAN>
    138. 

  138.  dialog. The symbols displayed by the <SPAN CLASS="Bold">
    139. 

  139. Member List </SPAN>
    140. 

  140. <A NAME="marker-1002727"></A>are included based upon these settings. </P>
    141. 

  141. <DIV>
    142. 

  142. <IMG SRC="clbrws-5.gif">
    143. 

  143. </DIV>
    144. 

  144. <P CLASS="BodyHang1">
    145. 

  145. <A NAME="pgfId-996828"></A><B>All</B><BR>
    146. 

  146. Sets all selections.</P>
    147. 

  147. <P CLASS="BodyHang1">
    148. 

  148. <A NAME="pgfId-1002770"></A><B>None</B><BR>
    149. 

  149. Clears all selections.</P>
    150. 

  150. <P CLASS="BodyHang1">
    151. 

  151. <A NAME="pgfId-1002752"></A><B>Methods, Instance Variables, Friends</B><BR>
    152. 

  152. Shows methods based on their types.</P>
    153. 

  153. <P CLASS="BodyHang1">
    154. 

  154. <A NAME="pgfId-1002761"></A><B>public, private, protected</B><BR>
    155. 

  155. Shows members based on their access level.</P>
    156. 

  156. <P CLASS="BodyHang1">
    157. 

  157. <A NAME="pgfId-1002773"></A><B>AND</B><BR>
    158. 

  158. If AND is selected, only functions matching <EM CLASS="Italics">
    159. 

  159. all</EM>
    160. 

  160.  attributes will be shown. If AND is not selected, functions matching any of the attributes will be shown. </P>
    161. 

  161. <P CLASS="BodyHang1">
    162. 

  162. <A NAME="pgfId-996830"></A><B>static, structor, inline, virtual, pure virtual</B><BR>
    163. 

  163. Shows members based on their attributes.</P>
    164. 

  164. <P CLASS="BodyHang1">
    165. 

  165. <A NAME="pgfId-997448"></A><B>overridden</B><BR>
    166. 

  166. Shows members that are overridden from a base class. You can also display these by selecting the <SPAN CLASS="Bold">
    167. 

  167. overridden</SPAN>
    168. 

  168.  checkbox in the main window.</P>
    169. 

  169. <P CLASS="BodyHang1">
    170. 

  170. <A NAME="pgfId-1002827"></A><B>overloaded</B><BR>
    171. 

  171. Shows functions that have more than one type signature in the class.</P>
    172. 

  172. <H3 CLASS="Heading2">
    173. 

  173. <A NAME="pgfId-1165358"></A>Scope Selector</H3>
    174. 

  174. <P CLASS="Body">
    175. 

  175. <A NAME="pgfId-1165361"></A>The <A NAME="marker-1165359"></A><SPAN CLASS="Bold">
    176. 

  176. Scope Selector</SPAN>
    177. 

  177.  menu filters the member list by the accessibility of the members. </P>
    178. 

  178. <DIV>
    179. 

  179. <IMG SRC="clbrws-6.gif">
    180. 

  180. </DIV>
    181. 

  181. <P CLASS="BodyHang1">
    182. 

  182. <A NAME="pgfId-1165363"></A><A NAME="marker-1165362"></A><B>subclass</B><BR>
    183. 

  183. Shows only the members accessible to new subclasses of the currently browsed class. Does not include private members of the currently browsed class or private base classes.</P>
    184. 

  184. <P CLASS="BodyHang1">
    185. 

  185. <A NAME="pgfId-997466"></A><A NAME="marker-997465"></A><B>class</B><BR>
    186. 

  186. Shows only the accessible members of the currently browsed class; private members of base classes are not included.</P>
    187. 

  187. <P CLASS="BodyHang1">
    188. 

  188. <A NAME="pgfId-996857"></A><A NAME="marker-996856"></A><B>baseclass</B><BR>
    189. 

  189. Shows all members, including the private members of the base classes.</P>
    190. 

  190. <P CLASS="Body">
    191. 

  191. <A NAME="pgfId-1167482"></A>
    192. 

  192. <HR ALIGN="center">
    193. 

  193. <TABLE CLASS="TABLE" WIDTH="100" BORDER="0" ALIGN="center" CELLPADDING="1">
    194. 

  194. <TR>
    195. 

  195. <TH COLSPAN="3" ALIGN="center">
    196. 

  196. <P CLASS="Gotos">
    197. 

  197. </P>
    198. 

  198. </TH></TR>
    199. 

  199. <TR><TD ALIGN="center">
    200. 

  200. <P CLASS="Gotos"><A HREF="index_ug.html">Contents</A>
    201. 

  201. </P></TD>
    202. 

  202. <TD ALIGN="center">
    203. 

  203. <P CLASS="Gotos"><A HREF="clhierbrws.html">Previous</A></P></TD>
    204. 

  204. <TD ALIGN="center">
    205. 

  205. <P CLASS="Gotos">
    206. 

  206. <A HREF="crossref.html">Next</A></P></TD>
    207. 

  207. </TR></TABLE>
    208. 

  208. </BODY>
    209. 

  209. </HTML>
    210. 

  210.