Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`python`.`shortcut`.`Shortcut``

class documentation

`class Shortcut: (source)`

Constructor: `Shortcut(path, arguments, description, workingdir, ...)`

View In Hierarchy

A shortcut on Win32.

Method | `__getattr__` | Undocumented
Method | `__init__` | No summary
Method | `load` | Read a shortcut file from disk.
Method | `save` | Write the shortcut to disk.
Instance Variable | `_base` | Undocumented

def __getattr__(self, name): (source)

Undocumented

def __init__(self, path=None, arguments=None, description=None, workingdir=None, iconpath=None, iconidx=0): (source)

Parameters
path | Location of the target
arguments | If path points to an executable, optional arguments to pass
description | Human-readable description of target
workingdir | Directory from which target is launched
iconpath | Filename that contains an icon for the shortcut
iconidx | If iconpath is set, optional index of the icon desired

def load(self, filename): (source)

Read a shortcut file from disk.

def save(self, filename): (source)

Write the shortcut to disk.

The file should be named something.lnk.

_base = (source)

Undocumented