Peter Lavender > Padre > Padre::Wx::Notebook

Download:
Padre-1.00.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.00   Source  

NAME ^

Padre::Wx::Notebook - Notebook that holds a set of editor objects

DESCRIPTION ^

Padre::Wx::Notebook implements the tabbed notebook in the main window that stores the editors for open documents in Padre.

METHODS ^

show_file

  $notebook->show_file('/home/user/path/script.pl');

The show_file method takes a single parameter of a fully resolved filesystem path, finds the notebook page containing the editor for that file, and sets that editor to be the currently selected foreground page.

Returns true if found and displayed, or false otherwise.

pageids

    my @ids = $notebook->pageids;

Return a list of all current tab ids (integers) within the notebook.

pages

    my @pages = $notebook->pages;

Return a list of all notebook tabs. Those are the real objects, not page ids, and should be Padre::Wx::Editor objects (although they are not guarenteed to be).

editors

    my @editors = $notebook->editors;

Return a list of all current editors. Those are the real objects, not page ids, and are guarenteed to be Padre::Wx::Editor objects.

Note: for now, this has the same meaning as the pages method, but this will change once we get specialised non-text entry tabs.

documents

    my @document = $notebook->documents;

Return a list of all current documents, in the specific order they are open in the notepad.

prefix

The prefix method scans the list of all local documents, and finds the common root directory for all of them.

COPYRIGHT & LICENSE ^

Copyright 2008-2013 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: