1Padre::Wx::Main(3) User Contributed Perl Documentation Padre::Wx::Main(3)
2
6 Padre::Wx::Main - The main window for the Padre IDE
7
9 "Padre::Wx::Main" implements Padre's main window. It is the window
10 containing the menus, the notebook with all opened tabs, the various
11 sub-windows (outline, subs, output, errors, etc).
12 It inherits from "Wx::Frame", so check Wx documentation to see all the
14 available methods that can be applied to it besides the added ones (see
15 below).
16
18 Constructor
19 There's only one constructor for this class.
20 "new"
22 my $main = Padre::Wx::Main->new($ide);
24 Create and return a new Padre main window. One should pass a "Padre"
26 object as argument, to get a reference to the Padre application.
27 Accessors
29 The following methods access the object attributes. They are both
30 getters and setters, depending on whether you provide them with an
31 argument. Use them wisely.
32 Accessors to GUI elements:
34 · "title"
36 · "config"
38 · "aui"
40 · "menu"
42 · "notebook"
44 · "left"
46 · "right"
48 · "functions"
50 · "todo"
52 · "outline"
54 · "directory"
56 · "bottom"
58 · "output"
60 · "syntax"
62 Accessors to operating data:
64 · "cwd"
66 Accessors that may not belong to this class:
68 "about"
70 my $dialog = $main->about;
72 Returns the About Padre dialog, creating it if needed.
74 "left"
76 my $panel = $main->left;
78 Returns the left toolbar container panel, creating it if needed.
80 "right"
82 my $panel = $main->right;
84 Returns the right toolbar container panel, creating it if needed.
86 "bottom"
88 my $panel = $main->bottom;
90 Returns the bottom toolbar container panel, creating it if needed.
92 "find"
94 my $find = $main->find;
96 Returns the find dialog, creating a new one if needed.
98 "findfast"
100 my $find = $main->findfast;
102 Return current quick find dialog. Create a new one if needed.
104 "replace"
106 my $replace = $main->replace;
108 Return current replace dialog. Create a new one if needed.
110 Public Methods
112 "load_files"
113 $main->load_files;
115 Load any default files: session from command-line, explicit list on
117 command- line, or last session if user has this setup, a new file, or
118 nothing.
119 "lock"
121 my $lock = $main->lock('UPDATE', 'BUSY', 'refresh_toolbar');
122 Create and return a guard object that holds resource locks of various
124 types.
125 The method takes a parameter list of the locks you wish to exist for
127 the current scope. Special types of locks are provided in capitals,
128 refresh/method locks are provided in lowercase.
129 The "UPDATE" lock creates a Wx repaint lock using the built in
131 Wx::WindowUpdateLocker class.
132 You should use an update lock during GUI construction/modification to
134 prevent screen flicker. As a side effect of not updating, the GUI
135 changes happen significantly faster as well. Update locks should only
136 be held for short periods of time, as the operating system will begin
137 to treat your\ application as "hung" if an update lock persists for
138 more than a few seconds. In this situation, you may begin to see GUI
139 corruption.
140 The "BUSY" lock creates a Wx "busy" lock using the built in
142 Wx::WindowDisabler class.
143 You should use a busy lock during times when Padre has to do a long
145 and/or complex operation in the foreground, or when you wish to disable
146 use of any user interface elements until a background thread is
147 finished.
148 Busy locks can be held for long periods of time, however your users may
150 start to suspect trouble if you do not provide any periodic feedback to
151 them.
152 Lowercase lock names are used to delay the firing of methods that will
154 themselves generate GUI events you may want to delay until you are sure
155 you want to rebuild the GUI.
156 For example, opening a file will require a Padre::Wx::Main refresh
158 call, which will itself generate more refresh calls on the directory
159 browser, the function list, output window, menus, and so on.
160 But if you open more than one file at a time, you don't want to refresh
162 the menu for the first file, only to do it again on the second, third
163 and fourth files.
164 By creating refresh locks in the top level operation, you allow the
166 lower level operation to make requests for parts of the GUI to be
167 refreshed, but have the actual refresh actions delayed until the lock
168 expires.
169 This should make operations with a high GUI intensity both simpler and
171 faster.
172 The name of the lowercase MUST be the name of a Padre::Wx::Main method,
174 which will be fired (with no parameters) when the method lock expires.
175 locked
177 This method provides the ability to check if a resource is currently
178 locked.
179 Single Instance Server
181 Padre embeds a small network server to handle single instance. Here are
182 the methods that allow to control this embedded server.
183 "single_instance_address"
185 $main->single_instance_address;
187 Determines the location of the single instance server for this instance
189 of Padre.
190 my $single_instance_port = 4444;
192 "single_instance_start"
194 $main->single_instance_start;
196 Start the embedded server. Create it if it doesn't exist. Return true
198 on success, die otherwise.
199 "single_instance_stop"
201 $main->single_instance_stop;
203 Stop & destroy the embedded server if it was running. Return true on
205 success.
206 "single_instance_running"
208 my $is_running = $main->single_instance_running;
210 Return true if the embedded server is currently running.
212 "single_instance_connect"
214 $main->single_instance_connect;
216 Callback called when a client is connecting to embedded server. This is
218 the case when user starts a new Padre, and preference "open all
219 documents in single Padre instance" is checked.
220 "single_instance_command"
222 $main->single_instance_command( $line );
224 Callback called when a client has issued a command $line while
226 connected on embedded server. Current supported commands are "open
227 $file" and "focus".
228 Window Geometry
230 Query properties about the state and shape of the main window
231 "window_width"
233 my $width = $main->window_width;
235 Return the main window width.
237 "window_height"
239 my $width = $main->window_height;
241 Return the main window height.
243 "window_left"
245 my $left = $main->window_left;
247 Return the main window position from the left of the screen.
249 "window_top"
251 my $top = $main->window_top;
253 Return the main window position from the top of the screen.
255 "window_save"
257 $main->window_save;
258 Saves the current main window geometry (left, top, width, height,
260 maximized).
261 Called during Maximize, Iconize, ShowFullScreen and Padre shutdown so
263 we can restart the next Padre instance at the last good
264 non-Maximize/Iconize location.
265 Saves and returns true if and only the window is regular or maximized.
267 Skips and returns false if the window is currently hidden, iconised, or
269 full screen.
270 Refresh Methods
272 Those methods refresh parts of Padre main window. The term "refresh"
273 and the following methods are reserved for fast, blocking, real-time
274 updates to the GUI, implying rapid changes.
275 "refresh"
277 $main->refresh;
279 Force refresh of all elements of Padre main window. (see below for
281 individual refresh methods)
282 "add_refresh_listener"
284 Adds an object which will have its "->refresh" method called whenever
286 the main refresh event is triggered. The refresh listener is stored as
287 a weak reference so make sure that you keep the listener alive
288 elsewhere.
289 If your object does not have a "->refresh" method, pass in a code
291 reference - it will be called instead.
292 Note that this method must return really quick. If you plan to do work
294 that takes longer, launch it via the Action::Queue mechanism and
295 perform it in the background.
296 "refresh_title"
298 Sets or updates the Window title.
300 "refresh_syntaxcheck"
302 $main->refresh_syntaxcheck;
304 Do a refresh of document syntax checking. This is a "rapid" change,
306 since actual syntax check is happening in the background.
307 "refresh_outline"
309 $main->refresh_outline;
310 Force a refresh of the outline panel.
312 "refresh_menu"
314 $main->refresh_menu;
316 Force a refresh of all menus. It can enable / disable menu entries
318 depending on current document or Padre internal state.
319 "refresh_menu_plugins"
321 $main->refresh_menu_plugins;
323 Force a refresh of just the plug-in menus.
325 "refresh_windowlist"
327 $main->refresh_windowlist
329 Force a refresh of the list of windows in the window menu
331 "refresh_recent"
333 Specifically refresh the Recent Files entries in the File dialog
335 "refresh_toolbar"
337 $main->refresh_toolbar;
339 Force a refresh of Padre's toolbar.
341 "refresh_status"
343 $main->refresh_status;
345 Force a refresh of Padre's status bar.
347 "refresh_status_template"
349 $main->refresh_status_templat;
351 Force a refresh of Padre's status bar. The part that is driven by a
353 template.
354 "refresh_cursorpos"
356 $main->refresh_cursorpos;
358 Force a refresh of the position of the cursor on Padre's status bar.
360 "refresh_functions"
362 $main->refresh_functions;
364 Force a refresh of the function list on the right.
366 "refresh_todo"
368 $main->refresh_todo;
370 Force a refresh of the TODO list on the right.
372 "refresh_directory"
374 Force a refresh of the directory tree
376 "refresh_aui"
378 This is a refresh method wrapper around the "AUI" "Update" method so
379 that it can be lock-managed by the existing locking system.
380 Interface Rebuilding Methods
382 Those methods reconfigure Padre's main window in case of drastic
383 changes (locale, etc.)
384 "change_style"
386 $main->change_style( $style, $private );
388 Apply $style to Padre main window. $private is a Boolean true if the
390 style is located in user's private Padre directory.
391 "change_locale"
393 $main->change_locale( $locale );
395 Change Padre's locale to $locale. This will update the GUI to reflect
397 the new locale.
398 "relocale"
400 $main->relocale;
402 The term and method "relocale" is reserved for functionality intended
404 to run when the application wishes to change locale (and wishes to do
405 so without restarting).
406 Note at this point, that the new locale has already been fixed, and
408 this method is usually called by "change_locale()".
409 "rebuild_toolbar"
411 $main->rebuild_toolbar;
413 Destroy and rebuild the toolbar. This method is useful because the
415 toolbar is not really flexible, and most of the time it's better to
416 recreate it from scratch.
417 Tools and Dialogs
419 Those methods deal with the various panels that Padre provides, and
420 allow to show or hide them.
421 "show_functions"
423 $main->show_functions( $visible );
425 Show the functions panel on the right if $visible is true. Hide it
427 otherwise. If $visible is not provided, the method defaults to show the
428 panel.
429 "show_todo"
431 $main->show_todo( $visible );
433 Show the to do panel on the right if $visible is true. Hide it
435 otherwise. If $visible is not provided, the method defaults to show the
436 panel.
437 "show_outline"
439 $main->show_outline( $visible );
441 Show the outline panel on the right if $visible is true. Hide it
443 otherwise. If $visible is not provided, the method defaults to show the
444 panel.
445 "show_debug"
447 $main->show_debug($visible);
449 "show_directory"
451 $main->show_directory( $visible );
453 Show the directory panel on the right if $visible is true. Hide it
455 otherwise. If $visible is not provided, the method defaults to show the
456 panel.
457 "show_output"
459 $main->show_output( $visible );
461 Show the output panel at the bottom if $visible is true. Hide it
463 otherwise. If $visible is not provided, the method defaults to show the
464 panel.
465 "show_findfast"
467 $main->show_findfast( $visible );
468 Show the Fast Find panel at the bottom of the editor area if $visible
470 is true. Hide it otherwise. If $visible is not provided, the method
471 defaults to show the panel.
472 "show_findinfiles"
474 $main->show_findinfiles( $visible );
476 Show the Find in Files panel at the bottom if $visible is true. Hide
478 it otherwise. If $visible is not provided, the method defaults to show
479 the panel.
480 "show_replaceinfiles"
482 $main->show_replaceinfiles( $visible );
484 Show the Replace in Files panel at the bottom if $visible is true.
486 Hide it otherwise. If $visible is not provided, the method defaults to
487 show the panel.
488 "show_command_line"
490 $main->show_command_line( $visible );
492 Show the command panel at the bottom if $visible is true. Hide it
494 otherwise. If $visible is not provided, the method defaults to show the
495 panel.
496 "show_syntaxcheck"
498 $main->show_syntaxcheck( $visible );
500 Show the syntax panel at the bottom if $visible is true. Hide it
502 otherwise. If $visible is not provided, the method defaults to show the
503 panel.
504 Search and Replace
506 find_dialog
507 $main->find_dialog;
508 Show the find dialog, escalating from the fast find if needed
510 Introspection
512 The following methods allow to poke into Padre's internals.
513 "current"
515 my $current = $main->current;
517 Creates a Padre::Current object for the main window, giving you quick
519 and caching access to the current various object members.
520 See Padre::Current for more information.
522 "pageids"
524 my @ids = $main->pageids;
526 Return a list of all current tab ids (integers) within the notebook.
528 "pages"
530 my @pages = $main->pages;
532 Return a list of all notebook tabs. Those are the real objects, not the
534 ids (see "pageids()" above).
535 "editors"
537 my @editors = $main->editors;
539 Return a list of all current editors. Those are the real objects, not
541 the ids (see "pageids()" above).
542 Note: for now, this has the same meaning as "pages()" (see above), but
544 this will change once we get project tabs or something else.
545 "documents"
547 my @document = $main->documents;
549 Return a list of all current documents, in the specific order they are
551 open in the notepad.
552 Process Execution
554 The following methods run an external command, for example to evaluate
555 current document.
556 "on_run_command"
558 $main->on_run_command;
560 Prompt the user for a command to run, then run it with "run_command()"
562 (see below).
563 Note: it probably needs to be combined with "run_command()" itself.
565 "on_run_tdd_tests"
567 $main->on_run_tdd_tests;
569 Callback method, to build and then call on_run_tests
571 "on_run_tests"
573 $main->on_run_tests;
575 Callback method, to run the project tests and harness them.
577 "on_run_this_test"
579 $main->on_run_this_test;
581 Callback method, to run the currently open test through prove.
583 "on_open_in_file_browser"
585 $main->on_open_in_file_browser( $filename );
587 Opens the current $filename using the operating system's file browser
589 "run_command"
591 $main->run_command( $command );
593 Run $command and display the result in the output panel.
595 "run_document"
597 $main->run_document( $debug )
599 Run current document. If $debug is true, document will be run with
601 diagnostics and various debug options.
602 Note: this should really be somewhere else, but can stay here for now.
604 Session Support
606 Those methods deal with Padre sessions. A session is a set of files /
607 tabs opened, with the position within the files saved, as well as the
608 document that has the focus.
609 "capture_session"
611 my @session = $main->capture_session;
613 Capture list of opened files, with information. Return a list of
615 "Padre::DB::SessionFile" objects.
616 "open_session"
618 $main->open_session( $session );
620 Try to close all files, then open all files referenced in the given
622 $session (a "Padre::DB::Session" object). No return value.
623 "save_session"
625 $main->save_session( $session, @session );
627 Try to save @session files ("Padre::DB::SessionFile" objects, such as
629 what is returned by "capture_session()" - see above) to database,
630 associated to $session. Note that $session should already exist.
631 User Interaction
633 Various methods to help send information to user.
634 Some methods are inherited from Padre::Wx::Role::Dialog.
636 "status"
638 $main->status( $msg );
639 Temporarily change the status bar leftmost block only to some message.
641 This is a super-quick method intended for transient messages as short
643 as a few tens of milliseconds (for example printing all directories
644 read during a recursive file scan).
645 "info"
647 $main->info( $msg );
649 Print a message on the status bar or within a dialog box depending on
651 the users preferences setting. The dialog has only a OK button and
652 there is no return value.
653 "prompt"
655 my $value = $main->prompt( $title, $subtitle, $key );
657 Prompt user with a dialog box about the value that $key should have.
659 Return this value, or "undef" if user clicked "cancel".
660 "simple_prompt"
662 my $value = $main->simple_prompt( $title, $subtitle, $default_text );
664 Prompt user with a dialog box about the value that $key should have.
666 Return this value, or "undef" if user clicked "cancel".
667 Search and Replace
669 These methods provide the highest level abstraction for entry into the
670 various search and replace functions and dialogs.
671 However, they still represent abstract logic and should NOT be tied
673 directly to keystroke or menu events.
674 "search_next"
676 # Next match for a new explicit search
677 $main->search_next( $search );
678 # Next match on current search
680 $main->search_next;
681 Find the next match for the current search.
683 If no files are open, silently do nothing (don't even remember the new
685 search)
686 "search_previous"
688 # Previous match for a new search
689 $main->search_previous( $search );
690 # Previous match on current search (or show Find dialog if none)
692 $main->search_previous;
693 Find the previous match for the current search, or spawn the Find
695 dialog.
696 If no files are open, do nothing.
698 "replace_next"
700 # Next replace for a new search
701 $main->replace_next( $search );
702 # Next replace on current search (or show Find dialog if none)
704 $main->replace_next;
705 Replace the next match for the current search, or spawn the Replace
707 dialog.
708 If no files are open, do nothing.
710 "replace_all"
712 # Replace all for a new search
713 $main->replace_all( $search );
714 # Replace all for the current search (or show Replace dialog if none)
716 $main->replace_all;
717 Replace all matches for the current search, or spawn the Replace
719 dialog.
720 If no files are open, do nothing.
722 General Events
724 Those methods are the various callbacks registered in the menus or
725 whatever widgets Padre has.
726 "on_brace_matching"
728 $main->on_brace_matching;
730 Jump to brace matching current the one at current position.
732 "on_comment_block"
734 $main->on_comment_block;
736 Performs one of the following depending the given operation
738 · Uncomment or comment selected lines, depending on their current
740 state.
741 · Comment out selected lines unilaterally.
743 · Uncomment selected lines unilaterally.
745 "on_autocompletion"
747 $main->on_autocompletion;
749 Try to auto complete current word being typed, depending on document
751 type.
752 "on_goto"
754 $main->on_goto;
756 Prompt user for a line or character position, and jump to this line or
758 character position in current document.
759 "on_close_window"
761 $main->on_close_window( $event );
763 Callback when window is about to be closed. This is our last chance to
765 veto the $event close, e.g. when some files are not yet saved.
766 If close is confirmed, save configuration to disk. Also, capture
768 current session to be able to restore it next time if user set Padre to
769 open last session on start-up. Clean up all Task Manager's tasks.
770 "setup_editors"
772 $main->setup_editors( @files );
774 Setup (new) tabs for @files, and update the GUI. If @files is "undef",
776 open an empty document.
777 "on_new"
779 $main->on_new;
781 Create a new empty tab. No return value.
783 "setup_editor"
785 $main->setup_editor( $file );
787 Setup a new tab / buffer and open $file, then update the GUI. Recycle
789 current buffer if there's only one empty tab currently opened. If $file
790 is already opened, focus on the tab displaying it. Finally, if $file
791 does not exist, create an empty file before opening it.
792 "create_tab"
794 my $tab = $main->create_tab;
796 Create a new tab in the notebook, and return its id (an integer).
798 "on_deparse"
800 Show what perl thinks about your code using B::Deparse
802 "on_open_selection"
804 $main->on_open_selection;
806 Try to open current selection in a new tab. Different combinations are
808 tried in order: as full path, as path relative to "cwd" (where the
809 editor was started), as path to relative to where the current file is,
810 if we are in a Perl file or Perl environment also try if the thing
811 might be a name of a module and try to open it locally or from @INC.
812 No return value.
814 "on_open_all_recent_files"
816 $main->on_open_all_recent_files;
818 Try to open all recent files within Padre. No return value.
820 "on_filter_tool"
822 $main->on_filter_tool;
824 Prompt user for a command to filter the selection/document.
826 "on_open_url"
828 $main->on_open_url;
830 Prompt user for URL to open and open it as a new tab.
832 Should be merged with ->on_open or at least a browsing function should
834 be added.
835 "on_open"
837 $main->on_open;
839 Prompt user for file(s) to open, and open them as new tabs. No return
841 value.
842 "on_open_with_default_system_editor"
844 $main->on_open_with_default_system_editor($filename);
846 Opens $filename in the default system editor
848 "on_open_in_command_line"
850 $main->on_open_in_command_line($filename);
852 Opens a command line/shell using the working directory of $filename
854 "on_open_example"
856 $main->on_open_example;
858 Opens the examples file dialog
860 "on_open_last_closed_file"
862 $main->on_open_last_closed_file;
864 Opens the last closed file in similar fashion to Chrome and Firefox.
866 "reload_all"
868 my $success = $main->reload_all;
870 Reload all open files from disk.
872 "reload_some"
874 my $success = $main->reload_some(@pages_to_reload);
876 Reloads the given documents. Return true upon success, false otherwise.
878 "reload_file"
880 $main->reload_file;
882 Try to reload a file from disk. Display an error if something went
884 wrong.
885 Returns 1 on success and 0 in case of and error.
887 "on_reload_file"
889 $main->on_reload_file;
891 Try to reload current file from disk. Display an error if something
893 went wrong. No return value.
894 "on_reload_all"
896 $main->on_reload_all;
898 Reload all currently opened files from disk. No return value.
900 "on_save"
902 my $success = $main->on_save;
904 Try to save current document. Prompt user for a file name if document
906 was new (see "on_save_as()" above). Return true if document has been
907 saved, false otherwise.
908 "on_save_as"
910 my $was_saved = $main->on_save_as;
912 Prompt user for a new file name to save current document, and save it.
914 Returns true if saved, false if cancelled.
915 "on_save_intuition"
917 my $success = $main->on_save_intuition;
919 Try to automatically determine an appropriate file name and save it,
921 based entirely on the content of the file.
922 Only do this for new documents, otherwise behave like a regular save.
924 "on_save_all"
926 my $success = $main->on_save_all;
928 Try to save all opened documents. Return true if all documents were
930 saved, false otherwise.
931 "_save_buffer"
933 my $success = $main->_save_buffer( $id );
935 Try to save buffer in tab $id. This is the method used underneath by
937 all "on_save_*()" methods. It will check if document has been updated
938 out of Padre before saving, and report an error if something went
939 wrong. Return true if buffer was saved, false otherwise.
940 "on_close"
942 $main->on_close( $event );
944 Handler when there is a close $event. Veto it if it's from the "AUI"
946 notebook, since Wx will try to close the tab no matter what. Otherwise,
947 close current tab. No return value.
948 "close"
950 my $success = $main->close( $id );
952 Request to close document in tab $id, or current one if no $id
954 provided. Return true if closed, false otherwise.
955 "close_all"
957 my $success = $main->close_all( $skip );
959 Try to close all documents. If $skip is specified (an integer), don't
961 close the tab with this id. Return true upon success, false otherwise.
962 "close_some"
964 my $success = $main->close_some(@pages_to_close);
966 Try to close all documents. Return true upon success, false otherwise.
968 "close_where"
970 # Close all files in current project
972 my $project = Padre::Current->document->project_dir;
973 my $success = $main->close_where( sub {
974 $_[0]->project_dir eq $project
975 } );
976 The "close_where" method is for closing multiple document windows. It
978 takes a subroutine as a parameter and calls that subroutine for each
979 currently open document, passing the document as the first parameter.
980 Any documents that return true will be closed.
982 "on_delete"
984 $main->on_delete;
986 Close the current tab and remove the associated file from disk. No
988 return value.
989 "delete"
991 my $success = $main->delete( $id );
993 Request to close document in tab $id, or current one if no $id provided
995 and DELETE THE FILE FROM DISK. Return true if closed, false otherwise.
996 "on_nth_path"
998 $main->on_nth_pane( $id );
1000 Put focus on tab $id in the notebook. Return true upon success, false
1002 otherwise.
1003 "on_next_pane"
1005 $main->on_next_pane;
1007 Put focus on tab next to current document. Currently, only left to
1009 right order is supported, but later on it can be extended to follow a
1010 last seen order.
1011 No return value.
1013 "on_prev_pane"
1015 $main->on_prev_pane;
1017 Put focus on tab previous to current document. Currently, only right to
1019 left order is supported, but later on it can be extended to follow a
1020 reverse last seen order.
1021 No return value.
1023 "on_diff"
1025 $main->on_diff;
1027 Run "Text::Diff" between current document and its last saved content on
1029 disk. This allow to see what has changed before saving. Display the
1030 differences in the output pane.
1031 "on_join_lines"
1033 $main->on_join_lines;
1035 Join current line with next one (à la vi with "Ctrl+J"). No return
1037 value.
1038 Preferences and toggle methods
1040 Those methods allow to change Padre's preferences.
1041 "zoom"
1043 $main->zoom( $factor );
1045 Apply zoom $factor to Padre's documents. Factor can be either positive
1047 or negative.
1048 "open_regex_editor"
1050 $main->open_regex_editor;
1052 Open Padre's regular expression editor. No return value.
1054 "open_perl_filter"
1056 $main->open_perl_filter;
1058 Open Padre's filter-through-perl. No return value.
1060 "on_key_bindings"
1062 $main->on_key_bindings;
1064 Opens the key bindings dialog
1066 "editor_linenumbers"
1068 $main->editor_linenumbers(1);
1070 Set visibility of line numbers on the left of the document.
1072 No return value.
1074 "editor_folding"
1076 $main->editor_folding(1);
1078 Enabled or disables code folding.
1080 No return value.
1082 "editor_currentline"
1084 $main->editor_currentline(1);
1086 Enable or disable background highlighting of the current line.
1088 No return value.
1090 "editor_rightmargin"
1092 $main->editor_rightmargin(1);
1094 Enable or disable display of the right margin.
1096 No return value.
1098 "editor_indentationguides"
1100 $main->editor_indentationguides(1);
1102 Enable or disable visibility of the indentation guides.
1104 No return value.
1106 "editor_eol"
1108 $main->editor_eol(1);
1110 Show or hide end of line carriage return characters.
1112 No return value.
1114 "editor_whitespace"
1116 $main->editor_whitespace;
1118 Show/hide spaces and tabs (with dots and arrows respectively). No
1120 return value.
1121 "on_word_wrap"
1123 $main->on_word_wrap;
1125 Toggle word wrapping for current document. No return value.
1127 "show_toolbar"
1129 $main->show_toolbar;
1131 Toggle toolbar visibility. No return value.
1133 "show_statusbar"
1135 $main->show_statusbar;
1137 Toggle status bar visibility. No return value.
1139 "on_toggle_lockinterface"
1141 $main->on_toggle_lockinterface;
1143 Toggle possibility for user to change Padre's external aspect. No
1145 return value.
1146 "on_insert_from_file"
1148 $main->on_insert_from_file;
1150 Prompt user for a file to be inserted at current position in current
1152 document. No return value.
1153 "convert_to"
1155 $main->convert_to( $eol_style );
1157 Convert document to $eol_style line endings (can be one of "WIN",
1159 "UNIX", or "MAC"). No return value.
1160 "editor_of_file"
1162 my $editor = $main->editor_of_file( $file );
1164 Return the editor (a "Padre::Wx::Editor" object) containing the wanted
1166 $file, or "undef" if file is not opened currently.
1167 "editor_id"
1169 my $id = $main->editor_id( $editor );
1171 Given $editor, return the tab id holding it, or "undef" if it was not
1173 found.
1174 Note: can this really work? What happens when we split a window?
1176 "run_in_padre"
1178 $main->run_in_padre;
1180 Evaluate current document within Padre. It means it can access all of
1182 Padre's internals, and wreak havoc. Display an error message if the
1183 evaluation went wrong, dump the result in the output panel otherwise.
1184 No return value.
1186 "STC" related methods
1188 Those methods are needed to have a smooth "STC" experience.
1189 "on_stc_style_needed"
1191 $main->on_stc_style_needed( $event );
1193 Handler of "EVT_STC_STYLENEEDED" $event. Used to work around some edge
1195 cases in scintilla. No return value.
1196 "on_stc_update_ui"
1198 $main->on_stc_update_ui;
1200 Handler called on every movement of the cursor. No return value.
1202 "on_stc_change"
1204 $main->on_stc_change;
1206 Handler of the "EVT_STC_CHANGE" event. Doesn't do anything. No return
1208 value.
1209 "on_stc_char_needed"
1211 $main->on_stc_char_added;
1213 This handler is called when a character is added. No return value. See
1215 <http://www.yellowbrain.com/stc/events.html#EVT_STC_CHARADDED>
1216 TO DO: maybe we need to check this more carefully.
1218 "on_stc_dwell_start"
1220 $main->on_stc_dwell_start( $event );
1222 Handler of the "DWELLSTART" $event. This event is sent when the mouse
1224 has not moved in a given amount of time. Doesn't do anything by now. No
1225 return value.
1226 "on_aui_pane_close"
1228 $main->on_aui_pane_close( $event );
1230 Handler called upon "EVT_AUI_PANE_CLOSE" $event. Doesn't do anything by
1232 now.
1233 "on_doc_stats"
1235 $main->on_doc_stats;
1237 Compute various stats about current document, and display them in a
1239 message. No return value.
1240 "on_tab_and_space"
1242 $main->on_tab_and_space( $style );
1244 Convert current document from spaces to tabs (or vice-versa) depending
1246 on $style (can be either of "Space_to_Tab" or "Tab_to_Space"). Prompts
1247 the user for how many spaces are to be used to replace tabs (whatever
1248 the replacement direction). No return value.
1249 "on_delete_ending_space"
1251 $main->on_delete_ending_space;
1253 Trim all ending spaces in current selection, or document if no text is
1255 selected. No return value.
1256 "on_delete_leading_space"
1258 $main->on_delete_leading_space;
1260 Trim all leading spaces in current selection. No return value.
1262 "timer_check_overwrite"
1264 $main->timer_check_overwrite;
1266 Called every n seconds to check if file has been overwritten outside of
1268 Padre. If that's the case, prompts the user whether s/he wants to
1269 reload the document. No return value.
1270 "on_last_visited_pane"
1272 $main->on_last_visited_pane;
1274 Put focus on tab visited before the current one. No return value.
1276 "on_oldest_visited_pane"
1278 $main->on_oldest_visited_pane;
1280 Put focus on tab visited the longest time ago. No return value.
1282 "on_duplicate"
1284 $main->on_duplicate;
1286 Create a new document and copy the contents of the current file. No
1288 return value.
1289 "on_new_from_template"
1291 $main->on_new_from_template( $extension );
1293 Create a new document according to template for $extension type of
1295 file. No return value.
1296 Auxiliary Methods
1298 Various methods that did not fit exactly in above categories...
1299 "action"
1301 Padre::Current->main->action('help.about');
1302 Single execution of a named action.
1304 "install_cpan"
1306 $main->install_cpan( $module );
1308 Install $module from "CPAN".
1310 Note: this method may not belong here...
1312 "setup_bindings"
1314 $main->setup_bindings;
1316 Setup the various bindings needed to handle output pane correctly.
1318 Note: I'm not sure those are really needed...
1320 "key_up"
1322 $main->key_up( $event );
1324 Callback for when a key up $event happens in Padre. This handles the
1326 various "Ctrl"+key combinations used within Padre.
1327 "new_document_from_string"
1329 $main->new_document_from_string( $string, $mimetype );
1331 Create a new document in Padre with the string value.
1333 Pass in an optional mime type to have Padre colorize the text
1335 correctly.
1336 Note: this method may not belong here...
1338
1340 Copyright 2008-2011 The Padre development team as listed in Padre.pm.
1341 This program is free software; you can redistribute it and/or modify it
1343 under the same terms as Perl itself.
1344 The full text of the license can be found in the LICENSE file included
1346 with this module.
1347perl v5.28.0 2018-07-15 Padre::Wx::Main(3)