mirror of https://github.com/python/cpython
open_new_win does not exist. use UNIX consistently, add autoraise parameter to open(). add versionadded tags to open_new_tab
This commit is contained in:
parent
196f733d93
commit
178f9068c4
|
@ -11,7 +11,7 @@ allow displaying Web-based documents to users. Under most
|
||||||
circumstances, simply calling the \function{open()} function from this
|
circumstances, simply calling the \function{open()} function from this
|
||||||
module will do the right thing.
|
module will do the right thing.
|
||||||
|
|
||||||
Under \UNIX, graphical browsers are preferred under X11, but text-mode
|
Under \UNIX{}, graphical browsers are preferred under X11, but text-mode
|
||||||
browsers will be used if graphical browsers are not available or an X11
|
browsers will be used if graphical browsers are not available or an X11
|
||||||
display isn't available. If text-mode browsers are used, the calling
|
display isn't available. If text-mode browsers are used, the calling
|
||||||
process will block until the user exits the browser.
|
process will block until the user exits the browser.
|
||||||
|
@ -26,9 +26,9 @@ substituted for the \code{\%s}; if the part does not contain
|
||||||
launch.
|
launch.
|
||||||
|
|
||||||
For non-\UNIX{} platforms, or when a remote browser is available on
|
For non-\UNIX{} platforms, or when a remote browser is available on
|
||||||
\UNIX, the controlling process will not wait for the user to finish
|
\UNIX{}, the controlling process will not wait for the user to finish
|
||||||
with the browser, but allow the remote browser to maintain its own
|
with the browser, but allow the remote browser to maintain its own
|
||||||
windows on the display. If remote browsers are not available on \UNIX,
|
windows on the display. If remote browsers are not available on \UNIX{},
|
||||||
the controlling process will launch a new browser and wait.
|
the controlling process will launch a new browser and wait.
|
||||||
|
|
||||||
The script \program{webbrowser} can be used as a command-line interface
|
The script \program{webbrowser} can be used as a command-line interface
|
||||||
|
@ -45,7 +45,7 @@ The following exception is defined:
|
||||||
|
|
||||||
The following functions are defined:
|
The following functions are defined:
|
||||||
|
|
||||||
\begin{funcdesc}{open}{url\optional{, new=0}\optional{, autoraise=1}}
|
\begin{funcdesc}{open}{url\optional{, new=0\optional{, autoraise=1}}}
|
||||||
Display \var{url} using the default browser. If \var{new} is 0, the
|
Display \var{url} using the default browser. If \var{new} is 0, the
|
||||||
\var{url} is opened in the same browser window. If \var{new} is 1,
|
\var{url} is opened in the same browser window. If \var{new} is 1,
|
||||||
a new browser window is opened if possible. If \var{new} is 2,
|
a new browser window is opened if possible. If \var{new} is 2,
|
||||||
|
@ -55,15 +55,15 @@ The following functions are defined:
|
||||||
|
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{open_new_win}{url}
|
\begin{funcdesc}{open_new}{url}
|
||||||
Open \var{url} in a new window of the default browser, if possible,
|
Open \var{url} in a new window of the default browser, if possible,
|
||||||
otherwise, open \var{url} in the only browser window. Alias
|
otherwise, open \var{url} in the only browser window.
|
||||||
\function{open_new}.
|
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{open_new_tab}{url}
|
\begin{funcdesc}{open_new_tab}{url}
|
||||||
Open \var{url} in a new page ("tab") of the default browser, if possible,
|
Open \var{url} in a new page ("tab") of the default browser, if possible,
|
||||||
otherwise equivalent to \function{open_new_win}.
|
otherwise equivalent to \function{open_new}.
|
||||||
|
\versionadded{2.5}
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{get}{\optional{name}}
|
\begin{funcdesc}{get}{\optional{name}}
|
||||||
|
@ -117,7 +117,7 @@ Notes:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[(1)]
|
\item[(1)]
|
||||||
``Konqueror'' is the file manager for the KDE desktop environment for
|
``Konqueror'' is the file manager for the KDE desktop environment for
|
||||||
UNIX, and only makes sense to use if KDE is running. Some way of
|
\UNIX{}, and only makes sense to use if KDE is running. Some way of
|
||||||
reliably detecting KDE would be nice; the \envvar{KDEDIR} variable is
|
reliably detecting KDE would be nice; the \envvar{KDEDIR} variable is
|
||||||
not sufficient. Note also that the name ``kfm'' is used even when
|
not sufficient. Note also that the name ``kfm'' is used even when
|
||||||
using the \program{konqueror} command with KDE 2 --- the
|
using the \program{konqueror} command with KDE 2 --- the
|
||||||
|
@ -141,13 +141,13 @@ Only on MacOS X platform.
|
||||||
Browser controllers provide two methods which parallel two of the
|
Browser controllers provide two methods which parallel two of the
|
||||||
module-level convenience functions:
|
module-level convenience functions:
|
||||||
|
|
||||||
\begin{funcdesc}{open}{url\optional{, new}}
|
\begin{funcdesc}{open}{url\optional{, new\optional{, autoraise=1}}}
|
||||||
Display \var{url} using the browser handled by this controller.
|
Display \var{url} using the browser handled by this controller.
|
||||||
If \var{new} is 1, a new browser window is opened if possible.
|
If \var{new} is 1, a new browser window is opened if possible.
|
||||||
If \var{new} is 2, a new browser page ("tab") is opened if possible.
|
If \var{new} is 2, a new browser page ("tab") is opened if possible.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{open_new_win}{url}
|
\begin{funcdesc}{open_new}{url}
|
||||||
Open \var{url} in a new window of the browser handled by this
|
Open \var{url} in a new window of the browser handled by this
|
||||||
controller, if possible, otherwise, open \var{url} in the only
|
controller, if possible, otherwise, open \var{url} in the only
|
||||||
browser window. Alias \function{open_new}.
|
browser window. Alias \function{open_new}.
|
||||||
|
@ -155,5 +155,6 @@ module-level convenience functions:
|
||||||
|
|
||||||
\begin{funcdesc}{open_new_tab}{url}
|
\begin{funcdesc}{open_new_tab}{url}
|
||||||
Open \var{url} in a new page ("tab") of the browser handled by this
|
Open \var{url} in a new page ("tab") of the browser handled by this
|
||||||
controller, if possible, otherwise equivalent to \function{open_new_win}.
|
controller, if possible, otherwise equivalent to \function{open_new}.
|
||||||
|
\versionadded{2.5}
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
Loading…
Reference in New Issue