MacPython / TextEdit / 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.

(TextEdit.app terminology, generated from /Applications/TextEdit.app)

Suites

Standard Suite Text Suite

Commands

close count delete duplicate exists get make move open print_ quit save set

Classes

application attachment attribute_run character color document item paragraph text window word

Standard Suite

Common classes and commands for most applications.

Commands

  • reference.get() – Get the data for an object.\

    • Result: Anything – the reply for the command

    reference.save(…) – Save an object.\

    • [as=UnicodeText] – The file type in which to save the data.
      [in_=Alias] – The file in which to save the object.
      Result: None

    reference.set(…) – Set an object’s data.\

    • to=Anything – The new value.
      Result: None

    application.print_(…) – Print an object.\

    • [Alias] – The file(s) or document(s) to be printed.
      Result: None

    reference.duplicate(…) – Copy object(s) and put the copies at a new location.\

    • to=InsertionLoc – The location for the new object(s).
      [with_properties=AERecord] – Properties to be set in the new duplicated object(s).
      Result: None

    reference.exists() – Verify if an object exists.\

    • Result: Boolean – the reply for the command

    reference.delete() – Delete an object.\

    • Result: None

    application.make(…) – Make a new object.\

    • [with_properties=AERecord] – The initial values for properties of the object.
      new=Type – The class of the new object.
      [with_data=Anything] – The initial data for the object.
      [at=InsertionLoc] – The location at which to insert the object.
      Result: ObjectSpecifier – the reply for the command

    application.open(…) – Open an object.\

    • [Alias] – The file(s) to be opened.
      Result: None

    reference.close(…) – Close an object.\

    • [saving=k.yes | k.no | k.ask] – Specifies whether changes should be saved before closing.
      [saving_in=Alias] – The file in which to save the object.
      Result: None

    reference.count(…) – Return the number of elements of a particular class within an object.\

    • [each=Type] – The class of objects to be counted.
      Result: SInt32 – the reply for the command

    reference.move(…) – Move object(s) to a new location.\

    • to=InsertionLoc – The new location for the object(s).
      Result: None

    reference.quit(…) – Quit an application.\

    • [saving=k.yes | k.no | k.ask] – Specifies whether changes should be saved before quitting.
      Result: None

Classes

  • document – A /TextEdit document.

    • Parent:

      Properties:

      • modified (r/o) Boolean – Has the document been modified since the last save?
        path UnicodeText – The document’s path.
        name UnicodeText – The document’s name.
        text k.text – The text of the document.\

    item – A scriptable object.

    window – A window.

    • Parent:

      Properties:

      • zoomed Boolean – Whether the window is currently zoomed.
        miniaturized Boolean – Whether the window is currently miniaturized.
        name UnicodeText – The full title of the window.
        floating (r/o) Boolean – Whether the window floats.
        modal (r/o) Boolean – Whether the window is the application’s current modal window.
        miniaturizable (r/o) Boolean – Whether the window can be miniaturized.
        visible Boolean – Whether the window is currently visible.
        closeable (r/o) Boolean – Whether the window has a close box.
        resizable (r/o) Boolean – Whether the window can be resized.
        zoomable (r/o) Boolean – Whether the window can be zoomed.
        id (r/o) SInt32 – The unique identifier of the window.
        bounds QDRectangle – The bounding rectangle of the window.
        titled (r/o) Boolean – Whether the window has a title bar.
        index SInt32 – The index of the window in the back-to-front window ordering.
        document (r/o) k.document – The document whose contents are being displayed in the window.\

    application – TextEdit’s top level scripting object.

    • Parent:

      Properties:

      • version (r/o) UnicodeText – The version of the application.
        frontmost (r/o) Boolean – Is this the frontmost (active) application?
        name (r/o) UnicodeText – The name of the application.\

      Elements:

      • windows – name | index | relative | range | test | id
        documents – name | index | relative | range | test\

    color – A color.

Text Suite

A set of basic classes for text processing.

Classes

  • attachment – Represents an inline text attachment. This class is used mainly for make commands.

    • Parent:

      Properties:

      • file_name UnicodeText – The path to the file for the attachment\

    text – Rich (styled) text

    • Parent:

      Children:

      Properties:

      • size SInt32 – The size in points of the first character.
        font UnicodeText – The name of the font of the first character.
        color k.color – The color of the first character.\

      Elements:

    attribute_run – This subdivides the text into chunks that all have the same attributes.

    • Parent:

      Properties:

      • size SInt32 – The size in points of the first character.
        font UnicodeText – The name of the font of the first character.
        color k.color – The color of the first character.\

      Elements:

    character – This subdivides the text into characters.

    • Parent:

      Properties:

      • size SInt32 – The size in points of the first character.
        font UnicodeText – The name of the font of the first character.
        color k.color – The color of the first character.\

      Elements:

    word – This subdivides the text into words.

    • Parent:

      Properties:

      • size SInt32 – The size in points of the first character.
        font UnicodeText – The name of the font of the first character.
        color k.color – The color of the first character.\

      Elements:

    paragraph – This subdivides the text into paragraphs.

    • Parent:

      Properties:

      • size SInt32 – The size in points of the first character.
        font UnicodeText – The name of the font of the first character.
        color k.color – The color of the first character.\

      Elements: