.. include:: headings.inc

.. currentmodule:: py.buffer

.. highlight:: python



.. _py.buffer.Buffer:

==========================================================================================================================================
|phoenix_title|  **Buffer**
==========================================================================================================================================

Buffer class.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Buffer**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.buffer.Buffer_inheritance.png" alt="Inheritance diagram of Buffer" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="py.buffer.Buffer.html" title="Buffer class." alt="" coords="5,5,120,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~py.buffer.Buffer.__init__`                                               Create a Buffer instance.
:meth:`~py.buffer.Buffer.addEditor`                                              Add an editor.
:meth:`~py.buffer.Buffer.hasChanged`                                             Return ``True`` if text in editor has changed since last save.
:meth:`~py.buffer.Buffer.new`                                                    New empty buffer.
:meth:`~py.buffer.Buffer.open`                                                   Open file into buffer.
:meth:`~py.buffer.Buffer.overwriteConfirm`                                       Confirm overwriting an existing file.
:meth:`~py.buffer.Buffer.save`                                                   Save buffer.
:meth:`~py.buffer.Buffer.saveAs`                                                 Save buffer.
:meth:`~py.buffer.Buffer.updateNamespace`                                        Update the namespace for autocompletion and calltips.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: Buffer

   Buffer class.

   .. method:: __init__(self, filename=None)

      Create a Buffer instance.


   .. method:: addEditor(self, editor)

      Add an editor.


   .. method:: hasChanged(self)

      Return ``True`` if text in editor has changed since last save.


   .. method:: new(self, filepath)

      New empty buffer.


   .. method:: open(self, filename)

      Open file into buffer.


   .. method:: overwriteConfirm(self, filepath)

      Confirm overwriting an existing file.


   .. method:: save(self)

      Save buffer.


   .. method:: saveAs(self, filename)

      Save buffer.


   .. method:: updateNamespace(self)

      Update the namespace for autocompletion and calltips.
      
      Return ``True`` if updated, ``False`` if there was an error.