PCEF 0.1.1 documentation

Welcome to PCEF documentation!

Contents   ::   What’s New?  »

Welcome to PCEF documentation!

Welcome to the PCEF documentation!

What is PCEF?

PCEF is code editing framework for PySide applications. It provides a flexible code editor ready to use in any PySide applications. Flexibility is achieved through a system of editor extensions (custom panels and modes).

At the moment, the framework only provides a generic code editor (language independent) but plans are to at least provides full support for python and maybe c++.

Here are the core features:

  • syntax highlighting mode (using pygments)
  • code completion (static word list, from document words)
  • line number Panel
  • code folding Panel
  • markers Panel (to add breakpoints, bookmarks, errors,...)
  • right margin indicator mode
  • active line highlighting mode
  • editor zoom mode
  • find and replace Panel
  • text decorations (squiggle, box)
  • unicode support (specify encoding when you load your file)
  • easy styling (built-in white and dark styles + possibility to customize using JSON style schemes)
  • flexible framework to add custom panels/modes
  • auto indent mode(indentation level is based on the previous line indent)

And here are some screenshots (taken from the generic_example v.0.1):

Default style Dark style

Parts of the documentation:

  • What’s New?

    What’s new since the last release, and what is planned for the next one.

  • Download

    Instructions on where and how to install PCEF.

  • Getting started

    An introduction to PCEF, covering some basic principles.

  • Advanced topics

    Cover advanced topics such as styling, creating custom modes and panels and so on.

  • Examples

    Practical examples demonstrating how to use the framework.

  • API Reference

    The api reference documentation

Meta information:

  • License

    PCEF license

  • Credits

    Credits to contributors and external libraries

Indices and tables:

Contents   ::   What’s New?  »