<type>documentation</type>
<domain>edit</domain>
<id>auto-completion</id>
<title>Auto-completion Icons</title>
<date>$Date$</date>
<version>$Revision$</version>
<product>all</product>

The auto-completer contains two columns of icons that indicate the origin and type
of the symbol.

**Symbol Origin**

|builtins| A Python builtin

|snippet|  A snippet defined in the ``Snippets`` tool

|argument| An argument for the current function or method scope

|runtime|  A symbol found by introspecting the live runtime state

.. |builtins| image:: images/autocomplete_builtin.png
  :class: inline-image
.. |snippet| image:: images/autocomplete_snippet.png
  :class: inline-image
.. |argument| image:: images/autocomplete_argument.png
  :class: inline-image
.. |runtime| image:: images/autocomplete_runtime.png
  :class: inline-image

**Symbol Type**

|keyword|    A Python keyword

|module|     A Python module

|class|      A class

|package|    A Python package

|method|     A method

|function|   A function

|dict|       A dictionary

|tuple|      A tuple

|list|       A list

|string|     A string

|integer|    An integer

|float|      A float

|exception|  An exception

|frame|      A Python stack frame

|instance|   An object instance of some other type
   
.. |keyword| image:: images/autocomplete_keyword.png
  :class: inline-image
.. |module| image:: images/autocomplete_module.png
  :class: inline-image
.. |class| image:: images/autocomplete_class.png
  :class: inline-image
.. |package| image:: images/autocomplete_package.png
  :class: inline-image
.. |method| image:: images/autocomplete_method.png
  :class: inline-image
.. |function| image:: images/autocomplete_function.png
  :class: inline-image
.. |instance| image:: images/autocomplete_instance.png
  :class: inline-image
.. |dict| image:: images/autocomplete_dict.png
  :class: inline-image
.. |tuple| image:: images/autocomplete_tuple.png
  :class: inline-image
.. |list| image:: images/autocomplete_list.png
  :class: inline-image
.. |string| image:: images/autocomplete_string.png
  :class: inline-image
.. |integer| image:: images/autocomplete_int.png
  :class: inline-image
.. |float| image:: images/autocomplete_float.png
  :class: inline-image
.. |exception| image:: images/autocomplete_exception.png
  :class: inline-image
.. |frame| image:: images/autocomplete_frame.png
  :class: inline-image

**Symbol Type Annotation**

Symbol type icons may be annotated, as in the following examples:

|inherited|  An upward pointing arrow indicates that the symbol was inherited from a superclass

|imported|   A leftward pointing arrow indicates that the symbol was imported with ``from x import <symbol>`` style import statement
  
.. |inherited| image:: images/autocomplete_class_inherited.png
  :class: inline-image
.. |imported| image:: images/autocomplete_class_imported.png
  :class: inline-image
