~ubuntu-branches/debian/squeeze/geany-plugins/squeeze

<tr><td width="5%"></td><td><tt>desc</tt> </td><td> -- A longer description of the filetype, e.g. "Lua source file" or "Cascading StyleSheet".</td></tr>

535

<tr><td width="5%"></td><td><tt>opener</tt> </td><td> -- The string used to begin a comment, e.g. "<!--".</td></tr>

536

<tr><td width="5%"></td><td><tt>closer</tt> </td><td> -- The string used to end a comment, e.g. "-->".</td></tr>

537

<tr><td width="5%"></td><td><tt>action</tt> </td><td> -- The action command as executed by the context menu</td></tr>

538

<tr><td width="5%"></td><td><tt>compiler</tt> </td><td> -- The command used to compile this type of file.</td></tr>

539

<tr><td width="5%"></td><td><tt>linker</tt> </td><td> -- The command used to link this type of file.</td></tr>

540

<tr><td width="5%"></td><td><tt>exec</tt> </td><td> -- The primary command used to execute this type of file.</td></tr>

541

<tr><td width="5%"></td><td><tt>exec2</tt> </td><td> -- An alternative command used to execute this type of file.</td></tr>

542

<tr><td width="5%"></td><td><tt>ftid</tt> </td><td> -- The unique numeric filetype identifier, as used by Geany.</td></tr>

543

<tr><td width="5%"></td><td><tt>encoding</tt> </td><td> -- The file's in-memory encoding. (may differ from the on-disk encoding.)</td></tr>

544

<tr><td width="5%"></td><td><tt>bom</tt> </td><td> -- <tt>true</tt> if the file contains a Byte-Order Marker.</td></tr>

545

<tr><td width="5%"></td><td><tt>changed</tt> </td><td> -- <tt>true</tt> if the file has unsaved changes.</td></tr>

546

<tr><td width="5%"></td><td><tt>readonly</tt> </td><td> -- <tt>true</tt> if the in-memory document is tagged as read-only.</td></tr>

547

</table>

548

549

550

551

552

<a name="find"></a><hr><h3><tt>geany.find ( phrase, start, stop, options )</tt></h3>

553

Searches within the current document for the string <tt>phrase</tt>, beginning at

554

the numeric <tt>start</tt> position and ending at the <tt>stop</tt> position.

555

( To search backwards, specify a <tt>start</tt> value greater than <tt>stop</tt> . )

556

557

558

559

The <tt>options</tt> argument is a table, each element may be one of the following strings:

560

561

562

563

"matchcase"</tt></td><td> -- A match only occurs with text that matches the case of the search string.

564

</td></tr>

565

566

"wholeword" </tt> </td><td> -- A match only occurs if the characters before and after are not word characters.

567

</td></tr>

568

569

"wordstart" </tt> </td><td> -- A match only occurs if the character before is not a word character.

570

</td></tr>

571

572

"regexp" </tt> </td><td> -- The search string should be interpreted as a regular expression.

573

</td></tr>

574

575

"posix" </tt> </td><td> -- Use bare parentheses

576

577

578

for tagged sections rather than the escaped <tt>\(</tt> and <tt>\)</tt>.

579

</td></tr>

580

581

( The empty set <tt>{}</tt> may also be specified, to search using the default options. )

582

</td></tr>

583

</table>

584

585

If a match is found, the function returns the starting and ending positions of the match,

586

otherwise it returns <tt>nil.</tt>

587

588

For example, to select the first case-sensitive whole-word match of the string

589

'foobar'  you could use something like this:

590

<pre>

591

a,b = geany.find( "foobar", 0, geany.length(), {"wholeword","matchcase"} )

592

if (a) then

593

geany.select(a,b)

594

else

595

geany.message("Search phrase not found.")

596

end

597

</pre>

598

599

600

601

<a name="fullpath"></a><hr><h3><tt>geany.fullpath ( filename )</tt></h3>

602

Returns the fully canonicalized form of the path to an existing named file, or <tt>nil</tt> if the path could not be found.

603

604

605

606

607

608

<a name="height"></a><hr><h3><tt>geany.height ()</tt></h3>

609

Returns the total number of lines in the current document.

610

611

612

<a name="keycmd"></a><hr><h3><tt>geany.keycmd ( command )</tt></h3>

613

Activates (runs) one of Geany's built-in menu commands.

614

The <tt>command</tt> argument should be one the string constants defined in the

615

"<tt>glspi_keycmd.h</tt>" header from the plugin sources.

616

For example, to display Geany's preferences dialog, you could use:

617

<tt>   geany.keycmd("MENU_PREFERENCES")</tt>

618

619

620

This function raises an error if the command argument is invalid.

621

622

623

624

625

626

627

<a name="keygrab"></a><hr><h3><tt>geany.keygrab ( [prompt] )</tt></h3>

628

629

Intercepts the next keyboard key pressed, preventing the editor from receiving

630

that keyboard event.

631

632

The function returns the value of the pressed key as a string,

633

alphanumeric keys will return their keyboard value, such as

634

<tt>"a"</tt>  or  <tt>"1"</tt>  while other keys may

635

return a string describing the key, such

636

as <tt>"Return"</tt> or <tt>"Escape"</tt>.

637

( Consult the file  <tt>gdk/gdkkeysyms.h</tt>  in the GTK sources for some idea of the key names. )

638

639

It should be possible to use this function on keyboards other than US,

640

although this hasn't been tested, and scripts written for one keyboard

641

might not be portable to another system.

642

Key combinations with the modifier keys  [Ctrl]  or  [Alt]

643

are not supported.   Detection of the  [Shift]  key state is somewhat supported,

644

although currently it may not be completely reliable.

645

  Repeatedly calling this function in rapid succession (as in a loop) may also result in some "dropped" keys,

646

so for best results its use should be confined to detecting a single "lowercase" key press.

647

648

If the optional <tt>prompt</tt> string argument is present, its text will be shown

649

as a "calltip" near the upper left-hand area of the current document.

650

(but only if there is a document open.)

651

652

This function was primarily intended for assigning "chained" sets of hot key

653

options, in conjunction with user-defined <a href="geanylua-keys.html">keybindings</a>.

654

655

656

657

658

659

660

661

662

663

664

665

<a name="launch"></a><hr><h3><tt>geany.launch ( program [, arg1 [, arg2, ...]] )</tt></h3>

666

Executes the external application specified by  <tt>program</tt>,

667

passing any additional arguments to its command line.

668

669

670

Returns <tt>true</tt> if the process was succesfully created, else it returns <tt>false</tt> plus an error message.

671

672

For example: <tt>

673

local ok,msg = geany.launch("firefox", "http://www.yahoo.com/")

674

if not ok then geany.message(msg) end</tt>

675

676

677

This function returns immediately, regardless of the status of the newly-created process.

678

If you need to wait for a process to complete before returning,

679

use Lua's built-in  <tt>os.execute()</tt>  function instead.

680

681

Note that using this function on MS-Windows might require installing the

682

"<tt>gspawn-win32-helper.exe</tt>" program somewhere in your <tt>PATH</tt>.

683

( It is included in the GTK/GLib package. )

684

685

686

687

<a name="length"></a><hr><h3><tt>geany.length ()</tt></h3>

688

Returns the text length of the current document.

689

690

691

692

<a name="lines"></a><hr><h3><tt>geany.lines ( [index] )</tt></h3>

693

When called with one argument, returns a string containing the text at

694

the specified line number of the current document.

695

It may also return <tt>nil</tt> if there is no open document,

696

or if the specified <tt>index</tt> is outside the range of lines.

697

698

When called without any arguments, it returns an iterator that steps

699

through each line of the current document.

700

So you can use it like this:<pre>

701

for line in geany.lines()

702

703

print(line)

704

end

705

</pre>

706

707

708

709

<a name="match"></a><hr><h3><tt>geany.match ( [position] )</tt></h3>

710

Attempts to find a corresponding matching brace from the given <tt>position</tt> of one brace.

711

( If the <tt>position</tt> argument is omitted, the current caret position is assumed. )

712

713

The brace characters handled are: <tt>  () [] {} <></tt>

714

The search is forwards from an opening brace and backwards from a closing brace.

715

If the character at <tt>position</tt> is not a brace character, or a matching brace cannot be found,

716

the return value is -1. Otherwise, the return value is the position of the matching brace.

717

718

719

720

721

<a name="navigate"></a><hr><h3><tt>geany.navigate ( mode, count [,extend [,rect]] )</tt></h3>

722

Moves the caret incrementally.

723

724

The  <tt>mode</tt>  argument must be one of the following strings:

725

<ul>

726

<li><tt>"char"</tt>   -- Move by characters.</li>

727

<li><tt>"part"</tt>   -- Move by segments in <big>MixedCase</big> or <big>under_score</big> style identifiers.</li>

728

<li><tt>"word"</tt>   -- Move by words.</li>

729

<li><tt>"edge"</tt>   -- Move to beginning or end of current line.</li>

730

<li><tt>"line"</tt>   -- Move up or down by lines.</li>

731

<li><tt>"para"</tt>   -- Move up or down by paragraphs.</li>

732

<li><tt>"page"</tt>   -- Move up or down by pages.</li>

733

<li><tt>"body"</tt>   -- Move to the beginning or end of the entire document.</li>

734

</ul>

735

736

If the numeric <tt>count</tt> argument is positive, the caret is moved forward or down by that many steps.

737

If it is negative, the caret is moved backward or up by that many steps.

738

( If it is zero there is not much point in using this function. )

739

There is also no point in using a magnitude greater than one for the <tt>"edge"</tt> or <tt>"body"</tt> modes.

740

741

742

If the optional boolean <tt>extend</tt> argument is <tt>true</tt>,

743

the selection is expanded or contracted to the new caret position,

744

similar to holding down the  <big>[Shift]</big>  key when navigating with the keyboard.

745

746

If the optional boolean <tt>rect</tt> argument is also <tt>true</tt>,

747

the selection is treated as rectangular rather than linear.

748

( Rectangular selection is only supported for <tt>char</tt>, <tt>edge</tt>,

749

<tt>line</tt>, or <tt>page</tt> modes. )

750

751

752

753

754

<a name="newfile"></a><hr><h3><tt>geany.newfile ( [filename] )</tt></h3>

755

When called with one argument, creates a new document with the specified

756

<tt>filename</tt>. When called with no arguments, creates a new, untitled document.

757

758

759

760

761

<a name="open"></a><hr><h3><tt>geany.open ( [filename]|[index] )</tt></h3>

762

When called with no arguments, reloads the currently active document from disk.

763

764

When called with a numeric argument, reloads the file of that document index.

765

766

When called with a string argument, it will reload that filename if it is already open,

767

or otherwise it will open it in a new tab.

768

It will not create a non-existent file, for that you need to use <tt>geany.newfile()</tt>

769

770

771

Returns the one-based document index on success,

772

or zero if the document could not be opened or reloaded.

773

774

775

<a name="optimize"></a><hr><h3><tt>geany.optimize ()</tt></h3>

776

Disables the Lua interpreter's "debug hook", the thing that

777

allows the plugin to track line number information and elapsed time.

778

The advantage of calling <tt>optimize()</tt> is that a lengthy, CPU-intensive

779

script can sometimes run much faster.

780

781

The disadvantage is that you lose the line number information that helps in

782

debugging your script, and the built-in protection against things like endless loops.

783

For this reason you should only use this function if you really need it, and

784

only when you are reasonably sure that your script doesn't contain any errors.

785

For best results this function should be called at the very

786

beginning of the script.

787

788

789

790

791

<a name="paste"></a><hr><h3><tt>geany.paste ()</tt></h3>

792

Pastes the text from the clipboard into the active document at the current caret position,

793

replacing any current selection.

794

795

Returns <tt>nil</tt> if there is no open document,

796

or if the document is marked read-only.

797

Otherwise it returns the effective change in the document's size.

798

( Which may actually be negative, if the clipboard content size is less than the prior selection. )

799

800

801

802

803

<a name="rescan"></a><hr><h3><tt>geany.rescan ()</tt></h3>

804

Scans the scripts folder, rebuilds the Tools->Lua Scripts menu,

805

and re-initializes the GTK accelerator group (keybindings) associated with the plugin.

806

807

808

809

<a name="rowcol"></a><hr><h3><tt>geany.rowcol ( [position]|[line,column] )</tt></h3>

810

This function translates between line/column coordinates and linear position (offset from beginning of document).

811

812

The syntax takes three forms:

813

<ul>

814

<li>

815

With no arguments, it returns the rectangular coordinates of the current caret position:

816

<tt>  line, column = geany.rowcol()</tt>

817

( Note that in Lua a single function call like the one above returns both values! )

818

</li>

819

<li>

820

With one argument, it it returns the rectangular coordinates of the specified <tt>position</tt>

821

argument:

822

<tt>  line, column = geany.rowcol(position)</tt>

823

</li>

824

825

<li>

826

With two arguments, it translates from the given <tt>line</tt> and <tt>column</tt>

827

to the linear position:

828

<tt>  position = geany.rowcol(line,column)</tt>

829

</li>

830

</ul>

831

832

Out-of-range arguments are adjusted to the nearest valid possibility.

833

834

835

<a name="save"></a><hr><h3><tt>geany.save ( [filename]|[index] )</tt></h3>

836

When called with no arguments, saves the currently active document to disk.

837

838

When called with a numeric argument, saves the file of that document index.

839

840

When called with a string argument, it will save that named document ( That is, of course, if it is open. )

841

842

843

Returns <tt>true</tt> on success, or <tt>false</tt> if the document could not be saved.

844

845

846

847

<a name="scintilla"></a><hr><h3><tt>geany.scintilla ( msg_id [, wparam [, lparam]] )</tt></h3>

848

Power users only!

849

850

851

Sends a <tt>SCI_*</tt> message directly to the Scintilla widget of the active document.

852

853

The <tt>msg_id</tt> can be a numeric value, or a case-insensitive string with or

854

without the <tt>"SCI_"</tt> prefix,

855

such as <tt>"SCI_POSITIONFROMPOINT"</tt>, <tt>"POSITIONFROMPOINT"</tt>, or <tt>"PositionFromPoint"</tt>.

856

857

The wparam, lparam, and return types depend on the particular message, based on the

858

interface described in the  "<tt>Scintilla.iface</tt>"  file from the Scintilla sources.

859

860

For API calls which expect a pre-allocated char buffer as the lparam, the allocation is

861

automatically managed

862

by the GeanyLua module, your lparam is ignored, and the return value is a Lua string. 

863

In cases where the length is specified

864

in the wparam, the null terminator is not counted - if you ask for 3 chars, you get 3 chars.

865

866

Currently only string, numeric, and boolean types are supported, any API call that

867

expects or returns complex types will result in an error.  This function tries hard to

868

protect from garbage being passed to

869

Scintilla, but ultimately you are expected to know what you're doing!

870

871

872

<a name="select"></a><hr><h3><tt>geany.select ( [[start,] stop]] )</tt></h3>

873

When called with no arguments, returns the beginning and ending points of

874

the current selection, in the form:

875

<tt>

876

  start, stop = geany.select()

877

</tt>

878

( Note that in Lua a single function call like the one above returns both values! )

879

880

To find out if the selection is rectangular, test the

881

boolean variable <tt>geany.rectsel</tt> immediately after this call.

882

883

884

If this function is called with two arguments, it creates a new selection in

885

the current document.

886

The selection is anchored at the <tt>start</tt>

887

position, and extended to the <tt>stop</tt> position.

888

The boolean variable <tt>geany.rectsel</tt> can be set prior to this

889

call to control

890

whether this selection is created in normal or rectangular mode.

891

892

893

If called with one argument, the caret is moved to that position, but no selection is created,

894

and any existing selection is lost.

895

896

897

898

Note that in all cases, the value of <tt>stop</tt> is considered to be

899

the end of the selection where the caret is located.

900

So, if <tt>stop</tt> is less than <tt>start</tt>, the caret is postioned

901

at the beginning of the selection, similar to a selection created by

902

dragging the mouse backwards in the document.

903

904

Hint: To select the entire document, you can use:

905

<tt>geany.select( 0, geany.length() )</tt>

906

907

908

909

<a name="selection"></a><hr><h3><tt>geany.selection ( [content] )</tt></h3>

910

When called with no arguments, returns the selected text in the current Geany

911

document as a string.

912

Returns the empty string if no text is selected, or <tt>nil</tt>

913

if there is no open document.

914

When called with one argument, the selected text of the current document

915

will be replaced with the specified <tt>content</tt>

916

string.

917

If no text is currently selected, the text will be inserted at the current

918

(caret) position.

919

920

921

<a name="signal"></a><hr><h3><tt>geany.signal ( widget, signal )</tt></h3>

922

Emits a GTK signal to a given widget in the Geany user interface.

923

The <tt>widget</tt> argument is a string identifying the widget by its Glade  <tt>"id"</tt>  attribute.

924

The <tt>signal</tt> argument is a string identifying the signal to be emitted.

925

926

This function was primarily intended for activating Geany's builtin menu commands.

927

For instance, to display the file open dialog you could do:

928

<tt>   geany.signal("menu_open1", "activate")</tt>

929

930

The function does not return a value, but may trigger an error message if the

931

widget name is not found or the signal name is not valid for the specified widget.

932

933

Note that it is generally easier and more reliable to use the <tt>keycmd()</tt> function whenever possible.

934

935

936

<a name="stat"></a><hr><h3><tt>geany.stat( filename [, lstat] )</tt></h3>

937

Returns a table providing some (limited) information about the specified file.

938

If the information could not be obtained, the function returns <tt>nil</tt> plus an string describing the reason for failure.

939

940

941

If the file is a symbolic link, and the optional  <tt>lstat</tt>  argument is <tt>true</tt>, the

942

information is returned about the link itself, otherwise the table provides

943

information about the file that the link points to.

944

945

The returned table contains the following fields:

946

947

<tr><td width="5%"></td><td><tt>size </tt></td><td> -- The size of the file, in bytes.</td></tr>

948

<tr><td width="5%"></td><td><tt>time </tt></td><td> -- Modification time, in seconds from the epoch.</td></tr>

949

<tr><td width="5%"></td><td><tt>type </tt></td><td> -- A single-character string that denotes the type of file (see below)</td></tr>

950

<tr><td width="5%"></td><td><tt>read </tt></td><td> -- <tt>true</tt> if the effective user can read from the file.</td></tr>

951

<tr><td width="5%"></td><td><tt>write</tt></td><td> -- <tt>true</tt> if the effective user can modify the file.</td></tr>

952

<tr><td width="5%"></td><td><tt>exec </tt></td><td> -- <tt>true</tt> if the effective user can execute the file.</td></tr>

953

</table>

954

955

The <tt>type</tt> field contains one of the following values:

956

957

<tr><td width="5%"></td><td><tt>"b" </tt></td><td> -- a block-oriented device.</td></tr>

958

<tr><td width="5%"></td><td><tt>"c" </tt></td><td> -- a character-special device.</td></tr>

959

<tr><td width="5%"></td><td><tt>"d" </tt></td><td> -- a directory.</td></tr>

960

<tr><td width="5%"></td><td><tt>"f" </tt></td><td> -- a FIFO or named pipe.</td></tr>

961

<tr><td width="5%"></td><td><tt>"l" </tt></td><td> -- a symbolic link.</td></tr>

962

<tr><td width="5%"></td><td><tt>"r" </tt></td><td> -- a regular file.</td></tr>

963

<tr><td width="5%"></td><td><tt>"s" </tt></td><td> -- a socket.</td></tr>

964

</table>

965

966

Note that this function does not support symbolic links or ACL permissions on MS-Windows.

967

968

969

970

971

<a name="text"></a><hr><h3><tt>geany.text ( [content] )</tt></h3>

972

When called with no arguments, returns the entire text of the currently

973

active Geany document as a string. ( Returns <tt>nil</tt>

974

if there is no open document.)

975

976

When called with one argument, the entire text of the current

977

document is replaced with the specified <tt>content</tt> string.

978

979

980

981

<a name="timeout"></a><hr><h3><tt>geany.timeout ( seconds )</tt></h3>

982

983

Attempts to control the maximum time allowed, in whole seconds, for the current script to

984

finish execution.

985

By default, scripts are allowed 15 seconds to complete, but if your script needs

986

more time, you can increase it here.

987

988

Note that the interpreter is only able to trigger this "timeout exceeded" error when it is actually processing instructions.

989

This provides protection against things like accidentally creating an endless loop,

990

but it might still be possible to create a script that hangs indefinitely. ( For instance if

991

you call <tt>io.read()</tt> without access to a terminal. )

992

The internal timer is paused whenever one of the dialog box functions is called,

993

to allow the user time to respond.

994

995

Setting the timeout to zero will disable it completely, that is, the script will never time out.

996

997

998

<a name="wkdir"></a><hr><h3><tt>geany.wkdir ( [folder] )</tt></h3>

999

When called with no arguments, returns the current working directory.

1000

1001

When called with one argument, tries to change into that <tt>folder</tt>,

1002

and returns <tt>true</tt> on sucess, or <tt>false</tt> plus an error message

1003

on failure.

1004

1005

1006

<a name="word"></a><hr><h3><tt>geany.word ( [position] )</tt></h3>

1007

When called with no arguments, returns the word at the current caret position.

1008

1009

When called with one argument, returns the word at the specified

1010

<tt>position</tt>.

1011

1012

This function can return an empty string if the position is not touching

1013

a character that is considered to be part of a word. You can modify this

1014

set of characters in the <tt>geany.wordchars</tt> variable.

1015

1016

1017

1018

<a name="xsel"></a><hr><h3><tt>geany.xsel ( [text] )</tt></h3>

1019

When called with no arguments, returns the text-based contents of the primary X selection.

1020

1021

When called with one argument, assigns that <tt>text</tt> as the contents of the primary X selection.

1022

1023

1024

This function is only valid for X-Window environments, on MS-Windows, it does nothing.

1025

1026

1027

<a name="yield"></a><hr><h3><tt>geany.yield ()</tt></h3>

1028

Temporarily returns control to the IDE, to allow user interface elements to

1029

be refreshed/repainted during lengthy script operations.

1030

Since most scripts will probably have a run time of less than a couple of seconds,

1031

you will likely never need this function. But if you do, it should be used with caution,

1032

since it allows Geany's state to be changed during script execution. This could have

1033

unpleasant consequences, for instance if the user closes a document that the script is referencing.

1034

1035

1036

1037

1038

1039

1040

<h3>      Dialog functions</h3>

1041

<hr>

1042

1043

<a name="choose"></a><hr><h3><tt>geany.choose ( prompt, items )</tt></h3>

1044

Displays a dialog box to allow the user to choose from a list of items.

1045

The <tt>prompt</tt> argument string will display a message above the list box

1046

to explain the request.

1047

The <tt>items</tt> argument is a Lua table, each element of the table must be

1048

a string.

1049

1050

The function returns the selected item as a string:

1051

<ul>

1052

<li>If the OK button is clicked,

1053

<li>If the [Return] key is pressed while the item list is active.

1054

<li>If the user double-clicks an item in the list.

1055

</ul>

1056

1057

If the Cancel button is clicked, or if the dialog is is dismissed by

1058

some other means, e.g. by pressing the [Escape] key, the function returns

1059

<tt>nil</tt>.

1060

1061

1062

1063

<a name="confirm"></a><hr><h3><tt>geany.confirm ( title, question, default )</tt></h3>

1064

Displays a simple yes-or-no style dialog box to ask the specified

1065

<tt>question</tt>.

1066

The <tt>title</tt> argument is displayed as a bold-faced title for the dialog.

1067

1068

Returns <tt>true</tt> if the 'Yes' button is clicked,

1069

or <tt>false</tt> if the 'No' button is

1070

clicked.

1071

If the dialog is dismissed by some other means, e.g. by pressing the

1072

[Escape] key, the function will return the boolean value specified by the

1073

<tt>default</tt> argument.

1074

All three arguments are required, but you can pass <tt>nil</tt>

1075

as the first argument to suppress the title.

1076

1077

1078

1079

<a name="input"></a><hr><h3><tt>geany.input ( [prompt] [,default] )</tt></h3>

1080

Displays an input dialog to prompt the user for some text.

1081

The <tt>prompt</tt> argument string will display a message above the entry box

1082

to explain what input is requested.

1083

The <tt>default</tt> argument string, if present, will add some pre-selected

1084

text into the entry area.

1085

If the OK button is clicked, or if the [Return] key is pressed while the

1086

entry field is active, the function will return the contents of the entry field

1087

as a string.

1088

If the Cancel button is clicked, or if the dialog is is dismissed by

1089

some other means, e.g. by pressing the

1090

[Escape] key, the function returns <tt>nil</tt>.

1091

1092

1093

1094

<a name="message"></a><hr><h3><tt>geany.message ( [title,] message )</tt></h3>

1095

When called with one argument, displays a simple dialog box containing

1096

the specified <tt>message</tt> string.

1097

When called with two arguments, the <tt>title</tt> argument is displayed as

1098

a bold-faced title,

1099

and the <tt>message</tt> argument will be the message text.

1100

1101

<hr>

1102

1103

<a name="pickfile"></a><hr><h3><tt>geany.pickfile ( [mode [,path [,filter]]] )</tt></h3>

1104

1105

Displays a dialog that allows the user to select a filename.

1106

All three arguments are optional, but you can pass <tt>nil</tt> as a placeholder to

1107

use the default value for any of the arguments.

1108

The <tt>mode</tt> argument specifies the type of dialog, and must be one

1109

of two strings, either <tt>"open"</tt> or <tt>"save"</tt>.

1110

( passing <tt>nil</tt> is the same as <tt>"open"</tt> )

1111

In <tt>"save"</tt> mode the function will issue an overwrite confirmation prompt if the targeted file already exists.

1112

1113

The <tt>path</tt> string argument sets the initial directory for the dialog, or <tt>nil</tt>

1114

to use the current directory.

1115

If the last (rightmost) element of the path is an existing directory, the path will be used as-is,

1116

otherwise the last element is assumed to be a filename (whether it actually exists on disk or not)

1117

and will be parsed off and used as the suggested filename for the dialog.

1118

1119

The <tt>filter</tt> argument controls which files are displayed,

1120

or it can be <tt>nil</tt> to display all files.

1121

It is a string consisting of pairs of substrings, where each substring

1122

is separated by the pipe "<tt>|</tt>" symbol.

1123

The first element in each pair of substrings is the human-readable description of the filetype,

1124

and the second element of the

1125

pair is a set of semicolon-delimited shell wildcards to filter on.

1126

For instance, a filter for web files might look like:

1127

1128

1129

( Those familiar with

1130

<a href="http://en.wikipedia.org/wiki/Borland_Delphi">Borland Delphi</a>

1131

might recognize this syntax from the

1132

<a href="http://www.delphibasics.co.uk/RTL.asp?Name=TOpenDialog">TOpenDialog.Filter</a> property. )

1133

1134

1135

Note that this function does not actually open or save anything, it merely returns the

1136

full path and filename of the selected file, or <tt>nil</tt> if the user cancels the dialog.

1137

1138

<hr>

1139

<hr>

1140

<h3>Module level variables</h3>

1141

<hr>

1142

<a name="wordchars"></a><hr><h3><tt>geany.wordchars</tt></h3>

1143

This variable determines which characters are considered to be part of a word.

1144

1145

It is used by the <tt>geany.word()</tt> function and may also be reset by that

1146

function if its current value cannot be interpreted as a string.

1147

The default value is: <tt>

1148

1149

"_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"</big> </big></tt>

1150

1151

If you need to modify this string, you may want to save a copy of the original

1152

so you can restore it later.

1153

1154

1155

<a name="rectsel"></a><hr><h3><tt>geany.rectsel</tt></h3>

1156

This variable controls and/or returns the "selection mode" of the current document.

1157

1158

It is used by the <tt>geany.select()</tt> function and is adjusted

1159

when the selection is queried, and examined when the selection is set.

1160

It may also be reset if its current value cannot be interpreted as a boolean.

1161

1162

A value of <tt>true</tt> represents a rectangular selection

1163

and <tt>false</tt> represents the normal linear selection mode.

1164

1165

1166

<a name="banner"></a><hr><h3><tt>geany.banner</tt></h3>

1167

This variable controls the window title for dialogs displayed by the current script.

1168

1169

It may be reset by the dialog functions if its value cannot be interpreted as a string.

1170

1171

1172

1173

<a name="caller"></a><hr><h3><tt>geany.caller</tt></h3>

1174

This variable stores the internal index of the document that triggered one of the <a href="./geanylua-intro.html#events">event scripts</a>.

1175

1176

For example, to print the filename of a file that has just been saved, you could put

1177

this line in your ~/.geany/plugins/lua/events/saved.lua script file:

1178

<tt>  print(geany.documents(geany.caller))</tt>

1179

1180

1181

1182

1183

1184

This variable is only relevant for the opened, created, activated, and saved event scripts,

1185

for all other scripts it is set to zero.

1186

1187

1188

1189

<a name="dirsep"></a><hr><h3><tt>geany.dirsep</tt></h3>

1190

This variable returns the default filesystem path separator.

1191

( A forward slash <tt>/</tt> for Unix or

1192

a backslash <tt>\</tt> for MS-Windows. )

1193

1194

1195

1196

<a name="project"></a><hr><h3><tt>geany.project</tt></h3>

1197

This variable provides a reference to the <a href="geanylua-keyfile.html">GKeyFile</a> object

1198

for the project that triggered a

1199

proj-*  <a href="./geanylua-intro.html#events">event script</a>.

1200

1201

The information stored in the object can be manipulated using the <tt>keyfile</tt> module.

1202

For example, to print the description of the project that has just been opened, you could put

1203

this line in your ~/.geany/plugins/lua/events/proj-opened.lua script file:

1204

<tt>  print(keyfile.value(geany.project, "project", "description"))</tt>

1205

1206

This variable is only relevant for the project-based event scripts, for all other scripts it is set to <tt>nil</tt>.

1207

1208

1209

1210

1211

<a name="script"></a><hr><h3><tt>geany.script</tt></h3>

1212

This variable stores the full path and filename of the active script.

1213

1214

<hr>

1215

1216

1217

1218

1219

1220

1221

1222

1223

</body>

1224

</html>

Older »