MacPython / FileMaker Pro Six Terminology¶
Legacy Wiki Page
This page was migrated from the old MoinMoin-based wiki. Information may be outdated or no longer applicable. For current documentation, see python.org.
(FileMaker Pro.app terminology, generated from /Applications/Development/FileMaker Pro 6/FileMaker Pro.app)
URL Suite¶
Standard Suite for Uniform Resource Locators
Commands¶
application.getURL(…) – Open a /FileMaker Pro database using a URL specification\
Text – The URL specification for the /FileMaker Pro database in the form “FMP5://[host]/filename”
Result: None
Subset of the Core, Table, and Database suites¶
Subset of Events supported by other Applications
Commands¶
application.begin_transaction() – Begin a transaction\
Result: SInt32 – The transaction ID
application.class_info(…) – Get information about an object class\
[Type] – The object class about which information is requested
[in_=IntlWritingCode] – The human language and script system in which to return information
Result: ClassInfo – A record containing the object’s properties and elements
reference.close() – Close an object\
Result: None
application.copy() – Copy an object to the clipboard\
Result: None
reference.count(…) – Return the number of elements of a particular class within an object\
class_=Type – The class of the elements to be counted
Result: SInt32 – The number of elements
application.create(…) – Create a new element\
new=Type – The class of the new element
[at=InsertionLoc] – The location at which to insert the element
[with_data=Anything] – The initial data for the element
[with_properties=AERecord] – The initial data for the properties of the element
Result: ObjectSpecifier – To the new object(s)
application.cut() – Cut an object to the clipboard\
Result: None
reference.data_size(…) – Return the size in bytes of an object\
[as=Type] – The data type for which the size is calculated
Result: SInt32 – The size of the object in bytes
reference.delete() – Delete an element from an object\
Result: None
application.do_menu(…) – Execute a menu command\
Anything – This denotes both the menu ID and the menu item
[menu_named=Text] – The name of the menu item
Result: Anything – Result of menu selection
application.do_script(…) – Execute a script\
Text – The name or specifier of the /FileMaker script to be executed
Result: Anything – The result of the Script
reference.duplicate(…) – Duplicate an object\
[to=InsertionLoc] – The new location for the object
Result: ObjectSpecifier – To the duplicated object(s)
application.end_transaction() – End a transaction\
Result: None
application.event_info(…) – Get information about the Apple events in a suite\
Type – The event class of the Apple events for which to return information
[in_=IntlWritingCode] – The human language and script system in which to return information
Result: list of EventInfo – A record containing the events and their parameters
reference.exists() – Tell if an object exists\
Result: Boolean – True if it exists, false if not
reference.get_data(…) – Get the data for an object\
[as=list of Type] – The desired types for the data, in order of preference
Result: Anything
reference.open(…) – Open an object\
[with_password=Text] – The password to use
Result: None
application.paste() – Paste an object from the clipboard\
Result: None
reference.print_() – Print an object\
Result: None
application.quit() – Perform tasks before termination, then terminate\
Result: None
application.redo() – Reverse the action of the immediately preceding undo\
Result: None
reference.save() – Save an object\
Result: None
reference.set_data(…) – Set an object’s data\
to=Anything – The new value
Result: None
reference.show() – Bring an object into view\
Result: None
reference.sort(…) – Sort the records in a layout\
[by=ObjectSpecifier] – The fields to sort by
[in_order=k.ascending | k.descending | k.custom] – The sort type
Result: None
application.undo() – Undo the action of the previous event or user interaction\
Result: None
Classes¶
application – The application
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
frontmost (r/o) Boolean – Is this the frontmost application?
name (r/o) IntlText – The name of the application
version (r/o) Version – The version of the application\
Elements:
window – A /FileMaker Pro document window
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the window
bounds QDRectangle – The bounding rectangle of the window
visible Boolean – Is the window visible?
index (r/o) SInt32 – The number of the window
floating (r/o) Boolean – Does the window float?
zoomable (r/o) Boolean – Is the window zoomable?
zoomed Boolean – Is the window zoomed?
modal (r/o) Boolean – Is the window modal?
resizable (r/o) Boolean – Is the window resizable?
has_close_box (r/o) Boolean – Does the window have a close box?
has_title_bar (r/o) Boolean – Does the window have a title bar?\
Elements:
documents – name | index
FileMaker_scripts – name | index | relative | range | test | id
databases – name | index\
document – A /FileMaker Pro document
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the document
modified (r/o) Boolean – True if the document has been modified\
Elements:
windows – index | name
databases – name | index
FileMaker_scripts – name | index | relative | range | test | id\
database – A /FileMaker Pro database
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the database
lock (r/o) k.unlocked | k.shared_lock | k.exclusive_lock – The current session’s lock on the database
current_layout ObjectSpecifier – The current layout
current_record ObjectSpecifier – The current record
access (r/o) k.no_access | k.read | k.write | k.update | k.create | k.delete | k.read_write | k.read_update | k.read_create | k.read_delete | k.write_update | k.write_create | k.write_delete | k.update_create | k.update_delete | k.write_delete | k.read_write_update | k.read_write_create | k.read_write_delete | k.write_update_create | k.write_update_delete | k.update_create_delete | k.read_create_delete | k.read_update_delete | k.write_create_delete | k.read_update_create | k.no_delete | k.no_create | k.no_update | k.no_read | k.no_write | k.full – The access privileges
multiuser Boolean – If true, users have access to the database over the network\
Elements:
layouts – name | index | relative | range | test | id
FileMaker_scripts – name | index | relative | range | test | id\
FileMaker_script – A /FileMaker script
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the /FileMaker Script
ID (r/o) LongFloat – The unique ID of the /FileMaker Script\
layout – A /FileMaker Pro layout
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the layout
ID (r/o) LongFloat – The unique ID of the layout
access (r/o) k.no_access | k.read | k.write | k.update | k.create | k.delete | k.read_write | k.read_update | k.read_create | k.read_delete | k.write_update | k.write_create | k.write_delete | k.update_create | k.update_delete | k.write_delete | k.read_write_update | k.read_write_create | k.read_write_delete | k.write_update_create | k.write_update_delete | k.update_create_delete | k.read_create_delete | k.read_update_delete | k.write_create_delete | k.read_update_create | k.no_delete | k.no_create | k.no_update | k.no_read | k.no_write | k.full – The access privileges of the layout
protection (r/o) k.read_only | k.formulas_protected | k.read_write – Indicates whether the formulas of the cells in the layout can be changed
lock (r/o) k.unlocked | k.shared_lock | k.exclusive_lock – The lock on the layout
kind (r/o) k.table | k.view – The kind of layout (View = /FileMaker Pro layout, table = all fields i.e. layout 0)
visible (r/o) Boolean – Is the layout visible in the layouts menu?\
Elements:
field – A /FileMaker Pro field
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
choices (r/o) AEList – The value list for the field
access (r/o) k.no_access | k.read | k.write | k.update | k.create | k.delete | k.read_write | k.read_update | k.read_create | k.read_delete | k.write_update | k.write_create | k.write_delete | k.update_create | k.update_delete | k.write_delete | k.read_write_update | k.read_write_create | k.read_write_delete | k.write_update_create | k.write_update_delete | k.update_create_delete | k.read_create_delete | k.read_update_delete | k.write_create_delete | k.read_update_create | k.no_delete | k.no_create | k.no_update | k.no_read | k.no_write | k.full – The access privileges for the field
formula (r/o) Text – The field’s calculation formula
ID (r/o) LongFloat – The unique ID of the field
lock (r/o) k.unlocked | k.shared_lock | k.exclusive_lock – The lock status of the field
name (r/o) Text – The name of the field
nulls_OK (r/o) Boolean – Is this field allowed to be empty?
protection (r/o) k.read_only | k.formulas_protected | k.read_write – The protection of this field
repeats (r/o) Enumeration – Is this a repeating field?
repeat_size (r/o) SInt32 – Maximum number of repetitions of the field
unique_value (r/o) Boolean – Must this field contain unique values?
globalValue (r/o) Boolean – Is this field a global field?\
Elements:
cells – name | index | relative | range | test | id\
record – A /FileMaker Pro record
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the record
ID (r/o) LongFloat – The unique ID of the record
lock (r/o) k.unlocked | k.shared_lock | k.exclusive_lock – The lock for the record
protection (r/o) k.read_only | k.formulas_protected | k.read_write – Indicates whether the formulas of the cells in the record can be changed
access (r/o) k.no_access | k.read | k.write | k.update | k.create | k.delete | k.read_write | k.read_update | k.read_create | k.read_delete | k.write_update | k.write_create | k.write_delete | k.update_create | k.update_delete | k.write_delete | k.read_write_update | k.read_write_create | k.read_write_delete | k.write_update_create | k.write_update_delete | k.update_create_delete | k.read_create_delete | k.read_update_delete | k.write_create_delete | k.read_update_create | k.no_delete | k.no_create | k.no_update | k.no_read | k.no_write | k.full – Indicates the access privileges for the record\
Elements:
cells – name | index | relative | range | test | id\
cell – A field value in a record or request
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
choices (r/o) AEList – The value list for the cell
formula (r/o) Text – The cell’s calculation formula
lock (r/o) k.unlocked | k.shared_lock | k.exclusive_lock – The lock status of the cell
name (r/o) Text – The cell’s name
protection (r/o) k.read_only | k.formulas_protected | k.read_write – The protection of this cell
cellValue Text – The cell value
ID (r/o) AEList – The unique ID of the cell (the first element is the record ID, the second element is the cell ID)
repeat_size (r/o) SInt32 – Number of repetitions of the cell
globalValue (r/o) Boolean – Is this cell a global cell?\
/FileMaker Suite¶
FileMaker Pro-specific events and objects
Commands¶
reference.go_to() – Go to an object\
Result: None
reference.find() – Perform a /FileMaker Pro Find given current requests\
Result: None
application.get_remote_URL() – Opens a hosted /FileMaker Pro database\
Result: Text – The URL specification for the opened database in the form “FMP5://[host]/filename”
Classes¶
request – A /FileMaker Pro find request
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name (r/o) IntlText – The name of the find request
ID (r/o) LongFloat – The unique ID of the find request
omitted Boolean – True if the request is to be omitted\
Elements:
cells – name | index | relative | range | test | id\
menu_item – A menu item
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name IntlText – The name of the menu item
ID SInt32 – The unique ID of the menu item
enabled Boolean – Is the menu item enabled?
item_number (r/o) ShortInteger – The menu item number
checked Boolean – Is the menu item checked?
notify_address TargetID – The target ID\
menu – A menu
Properties:
best_type (r/o) Type – The best descriptor type
class_ (r/o) Type – The class
default_type (r/o) Type – The default descriptor type
name IntlText – The name of the menu
ID (r/o) ShortInteger – The resource ID of the menu
enabled Boolean – Is the menu enabled?\
Elements:
menu_items – index | name
menus – index | name\
