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 · "errorlist"
64 Accessors to operating data:
66 · "cwd"
68 Accessors that may not belong to this class:
70 · "ack"
72 "find"
74 my $find = $main->find;
76 Returns the find dialog, creating a new one if needed.
78 "fast_find"
80 my $find = $main->fast_find;
82 Return current quick find dialog. Create a new one if needed.
84 "replace"
86 my $replace = $main->replace;
88 Return current replace dialog. Create a new one if needed.
90 Public Methods
92 "load_files"
93 $main->load_files;
95 Load any default files: session from command-line, explicit list on
97 command- line, or last session if user has this setup, a new file, or
98 nothing.
99 "lock"
101 my $lock = $main->lock('UPDATE', 'BUSY', 'refresh_toolbar');
102 Create and return a guard object that holds resource locks of various
104 types.
105 The method takes a parameter list of the locks you wish to exist for
107 the current scope. Special types of locks are provided in capitals,
108 refresh/method locks are provided in lowercase.
109 The "UPDATE" lock creates a Wx repaint lock using the built in
111 Wx::WindowUpdateLocker class.
112 You should use an update lock during GUI construction/modification to
114 prevent screen flicker. As a side effect of not updating, the GUI
115 changes happen significantly faster as well. Update locks should only
116 be held for short periods of time, as the operating system will begin
117 to treat your\ application as "hung" if an update lock persists for
118 more than a few seconds. In this situation, you may begin to see GUI
119 corruption.
120 The "BUSY" lock creates a Wx "busy" lock using the built in
122 Wx::WindowDisabler class.
123 You should use a busy lock during times when Padre has to do a long
125 and/or complex operation in the foreground, or when you wish to disable
126 use of any user interface elements until a background thread is
127 finished.
128 Busy locks can be held for long periods of time, however your users may
130 start to suspect trouble if you do not provide any periodic feedback to
131 them.
132 Lowercase lock names are used to delay the firing of methods that will
134 themselves generate GUI events you may want to delay until you are sure
135 you want to rebuild the GUI.
136 For example, opening a file will require a Padre::Wx::Main refresh
138 call, which will itself generate more refresh calls on the directory
139 browser, the function list, output window, menus, and so on.
140 But if you open more than one file at a time, you don't want to refresh
142 the menu for the first file, only to do it again on the second, third
143 and fourth files.
144 By creating refresh locks in the top level operation, you allow the
146 lower level operation to make requests for parts of the GUI to be
147 refreshed, but have the actual refresh actions delayed until the lock
148 expires.
149 This should make operations with a high GUI intensity both simpler and
151 faster.
152 The name of the lowercase MUST be the name of a Padre::Wx::Main method,
154 which will be fired (with no parameters) when the method lock expires.
155 locked
157 This method provides the ability to check if a resource is currently
158 locked.
159 Single Instance Server
161 Padre embeds a small network server to handle single instance. Here are
162 the methods that allow to control this embedded server.
163 "single_instance_start"
165 $main->single_instance_start;
167 Start the embedded server. Create it if it doesn't exist. Return true
169 on success, die otherwise.
170 "single_instance_stop"
172 $main->single_instance_stop;
174 Stop & destroy the embedded server if it was running. Return true on
176 success.
177 "single_instance_running"
179 my $is_running = $main->single_instance_running;
181 Return true if the embedded server is currently running.
183 "single_instance_connect"
185 $main->single_instance_connect;
187 Callback called when a client is connecting to embedded server. This is
189 the case when user starts a new Padre, and preference "open all
190 documents in single Padre instance" is checked.
191 "single_instance_command"
193 $main->single_instance_command( $line );
195 Callback called when a client has issued a command $line while
197 connected on embedded server. Current supported commands are "open
198 $file" and "focus".
199 Window Methods
201 Those methods allow to query properties about the main window.
202 "window_width"
204 my $width = $main->window_width;
206 Return the main window width.
208 "window_height"
210 my $width = $main->window_height;
212 Return the main window height.
214 "window_left"
216 my $left = $main->window_left;
218 Return the main window position from the left of the screen.
220 "window_top"
222 my $top = $main->window_top;
224 Return the main window position from the top of the screen.
226 Refresh Methods
228 Those methods refresh parts of Padre main window. The term "refresh"
229 and the following methods are reserved for fast, blocking, real-time
230 updates to the GUI, implying rapid changes.
231 "refresh"
233 $main->refresh;
235 Force refresh of all elements of Padre main window. (see below for
237 individual refresh methods)
238 "add_refresh_listener"
240 Adds an object which will have its "->refresh()" method called whenever
242 the main refresh event is triggered. The refresh listener is stored as
243 a weak reference so make sure that you keep the listener alive
244 elsewhere.
245 If your object does not have a "->refresh()" method, pass in a code
247 reference - it will be called instead.
248 Note that this method must return really quick. If you plan to do work
250 that takes longer, launch it via the Action::Queue mechanism and
251 perform it in the background.
252 "refresh_title"
254 Sets or updates the Window title.
256 "refresh_syntaxcheck"
258 $main->refresh_syntaxcheck;
260 Do a refresh of document syntax checking. This is a "rapid" change,
262 since actual syntax check is happening in the background.
263 "refresh_outline"
265 $main->refresh_outline;
266 Force a refresh of the outline panel.
268 "refresh_menu"
270 $main->refresh_menu;
272 Force a refresh of all menus. It can enable / disable menu entries
274 depending on current document or Padre internal state.
275 "refresh_menu_plugins"
277 $main->refresh_menu_plugins;
279 Force a refresh of just the plug-in menus.
281 "refresh_windowlist"
283 $main->refresh_windowlist
285 Force a refresh of the list of windows in the window menu
287 "refresh_recent"
289 Specifically refresh the Recent Files entries in the File dialog
291 "refresh_toolbar"
293 $main->refresh_toolbar;
295 Force a refresh of Padre's toolbar.
297 "refresh_status"
299 $main->refresh_status;
301 Force a refresh of Padre's status bar.
303 "refresh_cursorpos"
305 $main->refresh_cursorpos;
307 Force a refresh of the position of the cursor on Padre's status bar.
309 "refresh_functions"
311 $main->refresh_functions;
313 Force a refresh of the function list on the right.
315 "refresh_directory"
317 Force a refresh of the directory tree
319 "refresh_aui"
321 This is a refresh method wrapper around the "AUI" "Update" method so
322 that it can be lock-managed by the existing locking system.
323 Interface Rebuilding Methods
325 Those methods reconfigure Padre's main window in case of drastic
326 changes (locale, etc.)
327 "change_style"
329 $main->change_style( $style, $private );
331 Apply $style to Padre main window. $private is a Boolean true if the
333 style is located in user's private Padre directory.
334 "change_locale"
336 $main->change_locale( $locale );
338 Change Padre's locale to $locale. This will update the GUI to reflect
340 the new locale.
341 "relocale"
343 $main->relocale;
345 The term and method "relocale" is reserved for functionality intended
347 to run when the application wishes to change locale (and wishes to do
348 so without restarting).
349 Note at this point, that the new locale has already been fixed, and
351 this method is usually called by "change_locale()".
352 "reconfig"
354 $main->reconfig( $config );
356 The term and method "reconfig" is reserved for functionality intended
358 to run when Padre's underlying configuration is updated by an external
359 actor at run-time. The primary use cases for this method are when the
360 user configuration file is synced from a remote network location.
361 Note: This method is highly experimental and subject to change.
363 "rebuild_toolbar"
365 $main->rebuild_toolbar;
367 Destroy and rebuild the toolbar. This method is useful because the
369 toolbar is not really flexible, and most of the time it's better to
370 recreate it from scratch.
371 Tools and Dialogs
373 Those methods deal with the various panels that Padre provides, and
374 allow to show or hide them.
375 "show_functions"
377 $main->show_functions( $visible );
379 Show the functions panel on the right if $visible is true. Hide it
381 otherwise. If $visible is not provided, the method defaults to show the
382 panel.
383 "show_todo"
385 $main->show_todo( $visible );
387 Show the to do panel on the right if $visible is true. Hide it
389 otherwise. If $visible is not provided, the method defaults to show the
390 panel.
391 "show_outline"
393 $main->show_outline( $visible );
395 Show the outline panel on the right if $visible is true. Hide it
397 otherwise. If $visible is not provided, the method defaults to show the
398 panel.
399 "show_debugger"
401 $main->show_debugger( $visible );
403 "show_directory"
405 $main->show_directory( $visible );
407 Show the directory panel on the right if $visible is true. Hide it
409 otherwise. If $visible is not provided, the method defaults to show the
410 panel.
411 "show_output"
413 $main->show_output( $visible );
415 Show the output panel at the bottom if $visible is true. Hide it
417 otherwise. If $visible is not provided, the method defaults to show the
418 panel.
419 "show_syntax"
421 $main->show_syntax( $visible );
423 Show the syntax panel at the bottom if $visible is true. Hide it
425 otherwise. If $visible is not provided, the method defaults to show the
426 panel.
427 Introspection
429 The following methods allow to poke into Padre's internals.
430 "current"
432 my $current = $main->current;
434 Creates a Padre::Current object for the main window, giving you quick
436 and caching access to the current various object members.
437 See Padre::Current for more information.
439 "pageids"
441 my @ids = $main->pageids;
443 Return a list of all current tab ids (integers) within the notebook.
445 "pages"
447 my @pages = $main->pages;
449 Return a list of all notebook tabs. Those are the real objects, not the
451 ids (see "pageids()" above).
452 "editors"
454 my @editors = $main->editors;
456 Return a list of all current editors. Those are the real objects, not
458 the ids (see "pageids()" above).
459 Note: for now, this has the same meaning as "pages()" (see above), but
461 this will change once we get project tabs or something else.
462 "documents"
464 my @document = $main->documents;
466 Return a list of all current documents, in the specific order they are
468 open in the notepad.
469 Process Execution
471 The following methods run an external command, for example to evaluate
472 current document.
473 "on_run_command"
475 $main->on_run_command;
477 Prompt the user for a command to run, then run it with "run_command()"
479 (see below).
480 Note: it probably needs to be combined with "run_command()" itself.
482 "on_run_tdd_tests"
484 $main->on_run_tdd_tests;
486 Callback method, to build and then call on_run_tests
488 "on_run_tests"
490 $main->on_run_tests;
492 Callback method, to run the project tests and harness them.
494 "on_run_this_test"
496 $main->on_run_this_test;
498 Callback method, to run the currently open test through prove.
500 "on_open_in_file_browser"
502 $main->on_open_in_file_browser( $filename );
504 Opens the current $filename using the operating system's file browser
506 "run_command"
508 $main->run_command( $command );
510 Run $command and display the result in the output panel.
512 "run_document"
514 $main->run_document( $debug )
516 Run current document. If $debug is true, document will be run with
518 diagnostics and various debug options.
519 Note: this should really be somewhere else, but can stay here for now.
521 Session Support
523 Those methods deal with Padre sessions. A session is a set of files /
524 tabs opened, with the position within the files saved, as well as the
525 document that has the focus.
526 "capture_session"
528 my @session = $main->capture_session;
530 Capture list of opened files, with information. Return a list of
532 "Padre::DB::SessionFile" objects.
533 "open_session"
535 $main->open_session( $session );
537 Try to close all files, then open all files referenced in the given
539 $session (a "Padre::DB::Session" object). No return value.
540 "save_session"
542 $main->save_session( $session, @session );
544 Try to save @session files ("Padre::DB::SessionFile" objects, such as
546 what is returned by "capture_session()" - see above) to database,
547 associated to $session. Note that $session should already exist.
548 User Interaction
550 Various methods to help send information to user.
551 "message"
553 $main->message( $msg, $title );
555 Open a dialog box with $msg as main text and $title (title defaults to
557 "Message"). There's only one OK button. No return value.
558 "info"
560 $main->info( $msg );
562 Print a message on the status bar or within a dialog box depending on
564 the users preferences setting. The dialog has only a OK button and
565 there is no return value.
566 "error"
568 $main->error( $msg );
570 Open an error dialog box with $msg as main text. There's only one OK
572 button. No return value.
573 "prompt"
575 my $value = $main->prompt( $title, $subtitle, $key );
577 Prompt user with a dialog box about the value that $key should have.
579 Return this value, or "undef" if user clicked "cancel".
580 Search and Replace
582 These methods provide the highest level abstraction for entry into the
583 various search and replace functions and dialogs.
584 However, they still represent abstract logic and should NOT be tied
586 directly to keystroke or menu events.
587 "search_next"
589 # Next match for a new search
590 $main->search_next( $search );
591 # Next match on current search (or show Find dialog if none)
593 $main->search_next;
594 Find the next match for the current search, or spawn the Find dialog.
596 If no files are open, silently do nothing (don't even remember the new
598 search)
599 "search_previous"
601 # Previous match for a new search
602 $main->search_previous( $search );
603 # Previous match on current search (or show Find dialog if none)
605 $main->search_previous;
606 Find the previous match for the current search, or spawn the Find
608 dialog.
609 If no files are open, do nothing.
611 "replace_next"
613 # Next replace for a new search
614 $main->replace_next( $search );
615 # Next replace on current search (or show Find dialog if none)
617 $main->replace_next;
618 Replace the next match for the current search, or spawn the Replace
620 dialog.
621 If no files are open, do nothing.
623 "replace_all"
625 # Replace all for a new search
626 $main->replace_all( $search );
627 # Replace all for the current search (or show Replace dialog if none)
629 $main->replace_all;
630 Replace all matches for the current search, or spawn the Replace
632 dialog.
633 If no files are open, do nothing.
635 General Events
637 Those methods are the various callbacks registered in the menus or
638 whatever widgets Padre has.
639 "on_brace_matching"
641 $main->on_brace_matching;
643 Jump to brace matching current the one at current position.
645 "on_comment_block"
647 $main->on_comment_block;
649 Performs one of the following depending the given operation
651 · Uncomment or comment selected lines, depending on their current
653 state.
654 · Comment out selected lines unilaterally.
656 · Uncomment selected lines unilaterally.
658 "on_autocompletion"
660 $main->on_autocompletion;
662 Try to auto complete current word being typed, depending on document
664 type.
665 "on_goto"
667 $main->on_goto;
669 Prompt user for a line or character position, and jump to this line or
671 character position in current document.
672 "on_close_window"
674 $main->on_close_window( $event );
676 Callback when window is about to be closed. This is our last chance to
678 veto the $event close, e.g. when some files are not yet saved.
679 If close is confirmed, save configuration to disk. Also, capture
681 current session to be able to restore it next time if user set Padre to
682 open last session on start-up. Clean up all Task Manager's tasks.
683 "setup_editors"
685 $main->setup_editors( @files );
687 Setup (new) tabs for @files, and update the GUI. If @files is "undef",
689 open an empty document.
690 "on_new"
692 $main->on_new;
694 Create a new empty tab. No return value.
696 "setup_editor"
698 $main->setup_editor( $file );
700 Setup a new tab / buffer and open $file, then update the GUI. Recycle
702 current buffer if there's only one empty tab currently opened. If $file
703 is already opened, focus on the tab displaying it. Finally, if $file
704 does not exist, create an empty file before opening it.
705 "create_tab"
707 my $tab = $main->create_tab;
709 Create a new tab in the notebook, and return its id (an integer).
711 "on_open_selection"
713 $main->on_open_selection;
715 Try to open current selection in a new tab. Different combinations are
717 tried in order: as full path, as path relative to "cwd" (where the
718 editor was started), as path to relative to where the current file is,
719 if we are in a Perl file or Perl environment also try if the thing
720 might be a name of a module and try to open it locally or from @INC.
721 No return value.
723 "on_open_all_recent_files"
725 $main->on_open_all_recent_files;
727 Try to open all recent files within Padre. No return value.
729 "on_filter_tool"
731 $main->on_filter_tool;
733 Prompt user for a command to filter the selection/document.
735 "on_open_url"
737 $main->on_open_url;
739 Prompt user for URL to open and open it as a new tab.
741 Should be merged with ->on_open or at least a browsing function should
743 be added.
744 "on_open"
746 $main->on_open;
748 Prompt user for file(s) to open, and open them as new tabs. No return
750 value.
751 "on_open_with_default_system_editor"
753 $main->on_open_with_default_system_editor($filename);
755 Opens $filename in the default system editor
757 "on_open_in_command_line"
759 $main->on_open_in_command_line($filename);
761 Opens a command line/shell using the working directory of $filename
763 "on_open_example"
765 $main->on_open_example;
767 Opens the examples file dialog
769 "reload_all"
771 my $success = $main->reload_all;
773 Reload all open files from disk.
775 "reload_some"
777 my $success = $main->reload_some(@pages_to_reload);
779 Reloads the given documents. Return true upon success, false otherwise.
781 "reload_file"
783 $main->reload_file;
785 Try to reload a file from disk. Display an error if something went
787 wrong.
788 Returns 1 on success and 0 in case of and error.
790 "on_reload_file"
792 $main->on_reload_file;
794 Try to reload current file from disk. Display an error if something
796 went wrong. No return value.
797 "on_reload_all"
799 $main->on_reload_all;
801 Reload all currently opened files from disk. No return value.
803 "on_save"
805 my $success = $main->on_save;
807 Try to save current document. Prompt user for a file name if document
809 was new (see "on_save_as()" above). Return true if document has been
810 saved, false otherwise.
811 "on_save_as"
813 my $was_saved = $main->on_save_as;
815 Prompt user for a new file name to save current document, and save it.
817 Returns true if saved, false if cancelled.
818 "on_save_intuition"
820 my $success = $main->on_save_intuition;
822 Try to automatically determine an appropriate file name and save it,
824 based entirely on the content of the file.
825 Only do this for new documents, otherwise behave like a regular save.
827 "on_save_all"
829 my $success = $main->on_save_all;
831 Try to save all opened documents. Return true if all documents were
833 saved, false otherwise.
834 "_save_buffer"
836 my $success = $main->_save_buffer( $id );
838 Try to save buffer in tab $id. This is the method used underneath by
840 all "on_save_*()" methods. It will check if document has been updated
841 out of Padre before saving, and report an error if something went
842 wrong. Return true if buffer was saved, false otherwise.
843 "on_close"
845 $main->on_close( $event );
847 Handler when there is a close $event. Veto it if it's from the "AUI"
849 notebook, since Wx will try to close the tab no matter what. Otherwise,
850 close current tab. No return value.
851 "close"
853 my $success = $main->close( $id );
855 Request to close document in tab $id, or current one if no $id
857 provided. Return true if closed, false otherwise.
858 "close_all"
860 my $success = $main->close_all( $skip );
862 Try to close all documents. If $skip is specified (an integer), don't
864 close the tab with this id. Return true upon success, false otherwise.
865 "close_some"
867 my $success = $main->close_some(@pages_to_close);
869 Try to close all documents. Return true upon success, false otherwise.
871 "close_where"
873 # Close all files in current project
875 my $project = Padre::Current->document->project_dir;
876 my $success = $main->close_where( sub {
877 $_[0]->project_dir eq $project
878 } );
879 The "close_where" method is for closing multiple document windows. It
881 takes a subroutine as a parameter and calls that subroutine for each
882 currently open document, passing the document as the first parameter.
883 Any documents that return true will be closed.
885 "on_nth_path"
887 $main->on_nth_pane( $id );
889 Put focus on tab $id in the notebook. Return true upon success, false
891 otherwise.
892 "on_next_pane"
894 $main->on_next_pane;
896 Put focus on tab next to current document. Currently, only left to
898 right order is supported, but later on it can be extended to follow a
899 last seen order.
900 No return value.
902 "on_prev_pane"
904 $main->on_prev_pane;
906 Put focus on tab previous to current document. Currently, only right to
908 left order is supported, but later on it can be extended to follow a
909 reverse last seen order.
910 No return value.
912 "on_diff"
914 $main->on_diff;
916 Run "Text::Diff" between current document and its last saved content on
918 disk. This allow to see what has changed before saving. Display the
919 differences in the output pane.
920 "on_join_lines"
922 $main->on_join_lines;
924 Join current line with next one (a la vi with "Ctrl+J"). No return
926 value.
927 Preferences and toggle methods
929 Those methods allow to change Padre's preferences.
930 "zoom"
932 $main->zoom( $factor );
934 Apply zoom $factor to Padre's documents. Factor can be either positive
936 or negative.
937 "open_regex_editor"
939 $main->open_regex_editor;
941 Open Padre's regular expression editor. No return value.
943 "on_preferences"
945 $main->on_preferences;
947 Open Padre's preferences dialog. No return value.
949 "on_key_bindings"
951 $main->on_key_bindings;
953 Opens the key bindings dialog
955 "on_toggle_line_numbers"
957 $main->on_toggle_line_numbers;
959 Toggle visibility of line numbers on the left of the document. No
961 return value.
962 "on_toggle_code_folding"
964 $main->on_toggle_code_folding;
966 De/activate code folding. No return value.
968 "on_toggle_currentline"
970 $main->on_toggle_currentline;
972 Toggle background highlighting of current line. No return value.
974 "on_toggle_right_margin"
976 $main->on_toggle_right_margin;
978 Toggle display of right margin. No return value.
980 "on_toggle_syntax_check"
982 $main->on_toggle_syntax_check;
984 Toggle visibility of syntax panel. No return value.
986 "on_toggle_errorlist"
988 $main->on_toggle_errorlist;
990 Toggle visibility of error-list panel. No return value.
992 "on_toggle_indentation_guide"
994 $main->on_toggle_indentation_guide;
996 Toggle visibility of indentation guide. No return value.
998 "on_toggle_eol"
1000 $main->on_toggle_eol;
1002 Toggle visibility of end of line carriage returns. No return value.
1004 "on_toggle_whitespaces"
1006 $main->on_toggle_whitespaces;
1008 Show/hide spaces and tabs (with dots and arrows respectively). No
1010 return value.
1011 "on_word_wrap"
1013 $main->on_word_wrap;
1015 Toggle word wrapping for current document. No return value.
1017 "on_toggle_toolbar"
1019 $main->on_toggle_toolbar;
1021 Toggle toolbar visibility. No return value.
1023 "on_toggle_statusbar"
1025 $main->on_toggle_statusbar;
1027 Toggle status bar visibility. No return value.
1029 "on_toggle_lockinterface"
1031 $main->on_toggle_lockinterface;
1033 Toggle possibility for user to change Padre's external aspect. No
1035 return value.
1036 "on_insert_from_file"
1038 $main->on_insert_from_file;
1040 Prompt user for a file to be inserted at current position in current
1042 document. No return value.
1043 "convert_to"
1045 $main->convert_to( $eol_style );
1047 Convert document to $eol_style line endings (can be one of "WIN",
1049 "UNIX", or "MAC"). No return value.
1050 "find_editor_of_file"
1052 my $editor = $main->find_editor_of_file( $file );
1054 Return the editor (a "Padre::Wx::Editor" object) containing the wanted
1056 $file, or "undef" if file is not opened currently.
1057 "find_id_of_editor"
1059 my $id = $main->find_id_of_editor( $editor );
1061 Given $editor, return the tab id holding it, or "undef" if it was not
1063 found.
1064 Note: can this really work? What happens when we split a window?
1066 "run_in_padre"
1068 $main->run_in_padre;
1070 Evaluate current document within Padre. It means it can access all of
1072 Padre's internals, and wreak havoc. Display an error message if the
1073 evaluation went wrong, dump the result in the output panel otherwise.
1074 No return value.
1076 "STC" related methods
1078 Those methods are needed to have a smooth "STC" experience.
1079 "on_stc_style_needed"
1081 $main->on_stc_style_needed( $event );
1083 Handler of "EVT_STC_STYLENEEDED" $event. Used to work around some edge
1085 cases in scintilla. No return value.
1086 "on_stc_update_ui"
1088 $main->on_stc_update_ui;
1090 Handler called on every movement of the cursor. No return value.
1092 "on_stc_change"
1094 $main->on_stc_change;
1096 Handler of the "EVT_STC_CHANGE" event. Doesn't do anything. No return
1098 value.
1099 "on_stc_char_needed"
1101 $main->on_stc_char_added;
1103 This handler is called when a character is added. No return value. See
1105 <http://www.yellowbrain.com/stc/events.html#EVT_STC_CHARADDED>
1106 TO DO: maybe we need to check this more carefully.
1108 "on_stc_dwell_start"
1110 $main->on_stc_dwell_start( $event );
1112 Handler of the "DWELLSTART" $event. This event is sent when the mouse
1114 has not moved in a given amount of time. Doesn't do anything by now. No
1115 return value.
1116 "on_aui_pane_close"
1118 $main->on_aui_pane_close( $event );
1120 Handler called upon "EVT_AUI_PANE_CLOSE" $event. Doesn't do anything by
1122 now.
1123 "on_doc_stats"
1125 $main->on_doc_stats;
1127 Compute various stats about current document, and display them in a
1129 message. No return value.
1130 "on_tab_and_space"
1132 $main->on_tab_and_space( $style );
1134 Convert current document from spaces to tabs (or vice-versa) depending
1136 on $style (can be either of "Space_to_Tab" or "Tab_to_Space"). Prompts
1137 the user for how many spaces are to be used to replace tabs (whatever
1138 the replacement direction). No return value.
1139 "on_delete_ending_space"
1141 $main->on_delete_ending_space;
1143 Trim all ending spaces in current selection, or document if no text is
1145 selected. No return value.
1146 "on_delete_leading_space"
1148 $main->on_delete_leading_space;
1150 Trim all leading spaces in current selection. No return value.
1152 "timer_check_overwrite"
1154 $main->timer_check_overwrite;
1156 Called every n seconds to check if file has been overwritten outside of
1158 Padre. If that's the case, prompts the user whether s/he wants to
1159 reload the document. No return value.
1160 "on_last_visited_pane"
1162 $main->on_last_visited_pane;
1164 Put focus on tab visited before the current one. No return value.
1166 "on_oldest_visited_pane"
1168 $main->on_oldest_visited_pane;
1170 Put focus on tab visited the longest time ago. No return value.
1172 "on_new_from_template"
1174 $main->on_new_from_template( $extension );
1176 Create a new document according to template for $extension type of
1178 file. No return value.
1179 Auxiliary Methods
1181 Various methods that did not fit exactly in above categories...
1182 "install_cpan"
1184 $main->install_cpan( $module );
1186 Install $module from "CPAN".
1188 Note: this method may not belong here...
1190 "setup_bindings"
1192 $main->setup_bindings;
1194 Setup the various bindings needed to handle output pane correctly.
1196 Note: I'm not sure those are really needed...
1198 "key_up"
1200 $main->key_up( $event );
1202 Callback for when a key up $event happens in Padre. This handles the
1204 various "Ctrl"+key combinations used within Padre.
1205 "new_document_from_string"
1207 $main->new_document_from_string( $string, $mimetype );
1209 Create a new document in Padre with the string value.
1211 Pass in an optional mime type to have Padre colorize the text
1213 correctly.
1214 Note: this method may not belong here...
1216
1218 Copyright 2008-2010 The Padre development team as listed in Padre.pm.
1219 This program is free software; you can redistribute it and/or modify it
1221 under the same terms as Perl itself.
1222 The full text of the license can be found in the LICENSE file included
1224 with this module.
1225perl v5.12.1 2010-06-11 Padre::Wx::Main(3)