Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
5ab5503b
Commit
5ab5503b
authored
Apr 07, 1998
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Use {classdesc} and {memberdesc} where appropriate.
parent
a3f5c32f
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
40 additions
and
40 deletions
+40
-40
Doc/libmacic.tex
Doc/libmacic.tex
+20
-20
Doc/mac/libmacic.tex
Doc/mac/libmacic.tex
+20
-20
No files found.
Doc/libmacic.tex
View file @
5ab5503b
...
...
@@ -27,16 +27,16 @@ Exception raised on errors in the \module{ic} module.
\end{excdesc}
The
\module
{
ic
}
module defines the following
functions
:
The
\module
{
ic
}
module defines the following
class and function
:
\begin{
func
desc}
{
IC
}{
\optional
{
signature
\optional
{
, ic
}}}
\begin{
class
desc}
{
IC
}{
\optional
{
signature
\optional
{
, ic
}}}
Create an internet config object. The signature is a 4-character creator
code of the current application (default
\code
{
'Pyth'
}
) which may
influence some of ICs settings. The optional
\var
{
ic
}
argument is a
low-level
\code
{
icglue.icinstance
}
created beforehand, this may be
useful if you want to get preferences from a different config file,
etc.
\end{
func
desc}
\end{
class
desc}
\begin{funcdesc}
{
launchurl
}{
url
\optional
{
, hint
}}
\funcline
{
parseurl
}{
data
\optional
{
, start
\optional
{
, end
\optional
{
, hint
}}}}
...
...
@@ -48,14 +48,14 @@ described below.
\end{funcdesc}
\subsection
{
IC
o
bjects
}
\subsection
{
IC
O
bjects
}
IC objects have a mapping interface, hence to obtain the mail address
you simply get
\code
{
\var
{
ic
}
['MailAddress']
}
. Assignment also works,
and changes the option in the configuration file.
\class
{
IC
}
objects have a mapping interface, hence to obtain the mail
address you simply get
\code
{
\var
{
ic
}
['MailAddress']
}
. Assignment also
works,
and changes the option in the configuration file.
The module knows about various datatypes, and converts the internal IC
representation to a ``logical'' Python datastructure. Running the
representation to a ``logical'' Python data
structure. Running the
\module
{
ic
}
module standalone will run a test program that lists all
keys and values in your IC database, this will have to server as
documentation.
...
...
@@ -65,18 +65,18 @@ instance of the \code{ICOpaqueData} type, with the raw data in its
\member
{
data
}
attribute. Objects of this type are also acceptable values
for assignment.
Besides the dictionary interface IC objects have the following methods:
Besides the dictionary interface,
\class
{
IC
}
objects have the
following methods:
\setindexsubitem
{
(IC attribute)
}
\begin{
func
desc}
{
launchurl
}{
url
\optional
{
, hint
}}
\begin{
method
desc}
{
launchurl
}{
url
\optional
{
, hint
}}
Parse the given URL, lauch the correct application and pass it the
URL. The optional
\var
{
hint
}
can be a scheme name such as
\code
{
'mailto:'
}
, in which case incomplete URLs are completed with this
scheme. If
\var
{
hint
}
is not provided, incomplete URLs are invalid.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
parseurl
}{
data
\optional
{
, start
\optional
{
, end
\optional
{
, hint
}}}}
\begin{
method
desc}
{
parseurl
}{
data
\optional
{
, start
\optional
{
, end
\optional
{
, hint
}}}}
Find an URL somewhere in
\var
{
data
}
and return start position, end
position and the URL. The optional
\var
{
start
}
and
\var
{
end
}
can be
used to limit the search, so for instance if a user clicks in a long
...
...
@@ -84,9 +84,9 @@ textfield you can pass the whole textfield and the click-position in
\var
{
start
}
and this routine will return the whole URL in which the
user clicked. As above,
\var
{
hint
}
is an optional scheme used to
complete incomplete URLs.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
mapfile
}{
file
}
\begin{
method
desc}
{
mapfile
}{
file
}
Return the mapping entry for the given
\var
{
file
}
, which can be passed
as either a filename or an
\function
{
macfs.FSSpec()
}
result, and which
need not exist.
...
...
@@ -105,20 +105,20 @@ file type, \var{appname} is the printable name of the application to
which this file belongs,
\var
{
postappname
}
is the name of the
postprocessing application,
\var
{
mimetype
}
is the MIME type of this
file and
\var
{
entryname
}
is the name of this entry.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
maptypecreator
}{
type, creator
\optional
{
, filename
}}
\begin{
method
desc}
{
maptypecreator
}{
type, creator
\optional
{
, filename
}}
Return the mapping entry for files with given 4-character
\var
{
type
}
and
\var
{
creator
}
codes. The optional
\var
{
filename
}
may be specified to
further help finding the correct entry (if the creator code is
\code
{
'????'
}
, for instance).
The mapping entry is returned in the same format as for
\var
{
mapfile
}
.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
settypecreator
}{
file
}
\begin{
method
desc}
{
settypecreator
}{
file
}
Given an existing
\var
{
file
}
, specified either as a filename or as an
\function
{
macfs.FSSpec()
}
result, set its creator and type correctly based
on its extension. The finder is told about the change, so the finder
icon will be updated quickly.
\end{
func
desc}
\end{
method
desc}
Doc/mac/libmacic.tex
View file @
5ab5503b
...
...
@@ -27,16 +27,16 @@ Exception raised on errors in the \module{ic} module.
\end{excdesc}
The
\module
{
ic
}
module defines the following
functions
:
The
\module
{
ic
}
module defines the following
class and function
:
\begin{
func
desc}
{
IC
}{
\optional
{
signature
\optional
{
, ic
}}}
\begin{
class
desc}
{
IC
}{
\optional
{
signature
\optional
{
, ic
}}}
Create an internet config object. The signature is a 4-character creator
code of the current application (default
\code
{
'Pyth'
}
) which may
influence some of ICs settings. The optional
\var
{
ic
}
argument is a
low-level
\code
{
icglue.icinstance
}
created beforehand, this may be
useful if you want to get preferences from a different config file,
etc.
\end{
func
desc}
\end{
class
desc}
\begin{funcdesc}
{
launchurl
}{
url
\optional
{
, hint
}}
\funcline
{
parseurl
}{
data
\optional
{
, start
\optional
{
, end
\optional
{
, hint
}}}}
...
...
@@ -48,14 +48,14 @@ described below.
\end{funcdesc}
\subsection
{
IC
o
bjects
}
\subsection
{
IC
O
bjects
}
IC objects have a mapping interface, hence to obtain the mail address
you simply get
\code
{
\var
{
ic
}
['MailAddress']
}
. Assignment also works,
and changes the option in the configuration file.
\class
{
IC
}
objects have a mapping interface, hence to obtain the mail
address you simply get
\code
{
\var
{
ic
}
['MailAddress']
}
. Assignment also
works,
and changes the option in the configuration file.
The module knows about various datatypes, and converts the internal IC
representation to a ``logical'' Python datastructure. Running the
representation to a ``logical'' Python data
structure. Running the
\module
{
ic
}
module standalone will run a test program that lists all
keys and values in your IC database, this will have to server as
documentation.
...
...
@@ -65,18 +65,18 @@ instance of the \code{ICOpaqueData} type, with the raw data in its
\member
{
data
}
attribute. Objects of this type are also acceptable values
for assignment.
Besides the dictionary interface IC objects have the following methods:
Besides the dictionary interface,
\class
{
IC
}
objects have the
following methods:
\setindexsubitem
{
(IC attribute)
}
\begin{
func
desc}
{
launchurl
}{
url
\optional
{
, hint
}}
\begin{
method
desc}
{
launchurl
}{
url
\optional
{
, hint
}}
Parse the given URL, lauch the correct application and pass it the
URL. The optional
\var
{
hint
}
can be a scheme name such as
\code
{
'mailto:'
}
, in which case incomplete URLs are completed with this
scheme. If
\var
{
hint
}
is not provided, incomplete URLs are invalid.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
parseurl
}{
data
\optional
{
, start
\optional
{
, end
\optional
{
, hint
}}}}
\begin{
method
desc}
{
parseurl
}{
data
\optional
{
, start
\optional
{
, end
\optional
{
, hint
}}}}
Find an URL somewhere in
\var
{
data
}
and return start position, end
position and the URL. The optional
\var
{
start
}
and
\var
{
end
}
can be
used to limit the search, so for instance if a user clicks in a long
...
...
@@ -84,9 +84,9 @@ textfield you can pass the whole textfield and the click-position in
\var
{
start
}
and this routine will return the whole URL in which the
user clicked. As above,
\var
{
hint
}
is an optional scheme used to
complete incomplete URLs.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
mapfile
}{
file
}
\begin{
method
desc}
{
mapfile
}{
file
}
Return the mapping entry for the given
\var
{
file
}
, which can be passed
as either a filename or an
\function
{
macfs.FSSpec()
}
result, and which
need not exist.
...
...
@@ -105,20 +105,20 @@ file type, \var{appname} is the printable name of the application to
which this file belongs,
\var
{
postappname
}
is the name of the
postprocessing application,
\var
{
mimetype
}
is the MIME type of this
file and
\var
{
entryname
}
is the name of this entry.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
maptypecreator
}{
type, creator
\optional
{
, filename
}}
\begin{
method
desc}
{
maptypecreator
}{
type, creator
\optional
{
, filename
}}
Return the mapping entry for files with given 4-character
\var
{
type
}
and
\var
{
creator
}
codes. The optional
\var
{
filename
}
may be specified to
further help finding the correct entry (if the creator code is
\code
{
'????'
}
, for instance).
The mapping entry is returned in the same format as for
\var
{
mapfile
}
.
\end{
func
desc}
\end{
method
desc}
\begin{
func
desc}
{
settypecreator
}{
file
}
\begin{
method
desc}
{
settypecreator
}{
file
}
Given an existing
\var
{
file
}
, specified either as a filename or as an
\function
{
macfs.FSSpec()
}
result, set its creator and type correctly based
on its extension. The finder is told about the change, so the finder
icon will be updated quickly.
\end{
func
desc}
\end{
method
desc}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment