FCL/sftools/fbf/configs/default: doc/api/python/nokia.nokiaccm-module.html@09c37dab59b4 (annotated)

432 f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	1	<?xml version="1.0" encoding="ascii"?>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	3	"DTD/xhtml1-transitional.dtd">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	4	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	5	<head>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	6	<title>nokia.nokiaccm</title>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	7	<link rel="stylesheet" href="epydoc.css" type="text/css" />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	8	<script type="text/javascript" src="epydoc.js"></script>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	9	</head>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	10
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	11	<body bgcolor="white" text="black" link="blue" vlink="#204080"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	12	alink="#204080">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	13	<!-- ==================== NAVIGATION BAR ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	14	<table class="navbar" border="0" width="100%" cellpadding="0"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	15	bgcolor="#a0c0ff" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	16	<tr valign="middle">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	17
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	18	<!-- Tree link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	19	<th>   <a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	20	href="module-tree.html">Trees</a>   </th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	21
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	22	<!-- Index link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	23	<th>   <a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	24	href="identifier-index.html">Indices</a>   </th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	25
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	26	<!-- Help link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	27	<th>   <a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	28	href="help.html">Help</a>   </th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	29
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	30	<th class="navbar" width="100%"></th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	31	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	32	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	33	<table width="100%" cellpadding="0" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	34	<tr valign="top">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	35	<td width="100%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	36	<span class="breadcrumbs">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	37	<a href="nokia-module.html">Package nokia</a> ::
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	38	Module nokiaccm
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	39	</span>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	40	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	41	<td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	42	<table cellpadding="0" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	43	<!-- hide/show private -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	44	<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	45	onclick="toggle_private();">hide private</a>]</span></td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	46	<tr><td align="right"><span class="options"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	47	>[<a href="frames.html" target="_top">frames</a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	48	>] \| <a href="nokia.nokiaccm-module.html"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	49	target="_top">no frames</a>]</span></td></tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	50	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	51	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	52	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	53	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	54	<!-- ==================== MODULE DESCRIPTION ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	55	<h1 class="epydoc">Module nokiaccm</h1><span class="codelink"><a href="nokia.nokiaccm-pysrc.html">source code</a></span><br /><br />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	56	Nokia specific interface to Synergy sessions.<br /><br />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	57
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	58	<!-- ==================== FUNCTIONS ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	59	<a name="section-Functions"></a>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	60	<table class="summary" border="1" cellpadding="3"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	61	cellspacing="0" width="100%" bgcolor="white">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	62	<tr bgcolor="#70b0f0" class="table-header">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	63	<td colspan="2" class="table-header">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	64	<table border="0" cellpadding="0" cellspacing="0" width="100%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	65	<tr valign="top">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	66	<td align="left"><span class="table-header">Functions</span></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	67	<td align="right" valign="top"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	68	><span class="options">[<a href="#section-Functions"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	69	class="privatelink" onclick="toggle_private();"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	70	>hide private</a>]</span></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	71	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	72	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	73	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	74	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	75	<tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	76	<td width="15%" align="right" valign="top" class="summary">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	77	<span class="summary-type"> </span>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	78	</td><td class="summary">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	79	<table width="100%" cellpadding="0" cellspacing="0" border="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	80	<tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	81	<td><span class="summary-sig"><a href="nokia.nokiaccm-module.html#open_session" class="summary-sig-name">open_session</a>(<span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	82	<span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	83	<span class="summary-sig-arg">engine</span>=<span class="summary-sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	84	<span class="summary-sig-arg">dbpath</span>=<span class="summary-sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	85	<span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	86	<span class="summary-sig-arg">reuse</span>=<span class="summary-sig-default">True</span>)</span><br />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	87	Provides a Session object.</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	88	<td align="right" valign="top">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	89	<span class="codelink"><a href="nokia.nokiaccm-pysrc.html#open_session">source code</a></span>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	90
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	91	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	92	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	93	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	94
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	95	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	96	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	97	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	98	<!-- ==================== VARIABLES ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	99	<a name="section-Variables"></a>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	100	<table class="summary" border="1" cellpadding="3"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	101	cellspacing="0" width="100%" bgcolor="white">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	102	<tr bgcolor="#70b0f0" class="table-header">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	103	<td colspan="2" class="table-header">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	104	<table border="0" cellpadding="0" cellspacing="0" width="100%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	105	<tr valign="top">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	106	<td align="left"><span class="table-header">Variables</span></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	107	<td align="right" valign="top"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	108	><span class="options">[<a href="#section-Variables"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	109	class="privatelink" onclick="toggle_private();"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	110	>hide private</a>]</span></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	111	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	112	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	113	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	114	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	115	<tr class="private">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	116	<td width="15%" align="right" valign="top" class="summary">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	117	<span class="summary-type"> </span>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	118	</td><td class="summary">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	119	<a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger("nokia.nokiaccm")">logging.getLogger("nokia.nokiaccm")</code>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	120	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	121	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	122	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	123	<!-- ==================== FUNCTION DETAILS ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	124	<a name="section-FunctionDetails"></a>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	125	<table class="details" border="1" cellpadding="3"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	126	cellspacing="0" width="100%" bgcolor="white">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	127	<tr bgcolor="#70b0f0" class="table-header">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	128	<td colspan="2" class="table-header">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	129	<table border="0" cellpadding="0" cellspacing="0" width="100%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	130	<tr valign="top">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	131	<td align="left"><span class="table-header">Function Details</span></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	132	<td align="right" valign="top"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	133	><span class="options">[<a href="#section-FunctionDetails"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	134	class="privatelink" onclick="toggle_private();"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	135	>hide private</a>]</span></td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	136	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	137	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	138	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	139	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	140	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	141	<a name="open_session"></a>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	142	<div>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	143	<table class="details" border="1" cellpadding="3"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	144	cellspacing="0" width="100%" bgcolor="white">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	145	<tr><td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	146	<table width="100%" cellpadding="0" cellspacing="0" border="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	147	<tr valign="top"><td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	148	<h3 class="epydoc"><span class="sig"><span class="sig-name">open_session</span>(<span class="sig-arg">username</span>=<span class="sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	149	<span class="sig-arg">password</span>=<span class="sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	150	<span class="sig-arg">engine</span>=<span class="sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	151	<span class="sig-arg">dbpath</span>=<span class="sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	152	<span class="sig-arg">database</span>=<span class="sig-default">None</span>,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	153	<span class="sig-arg">reuse</span>=<span class="sig-default">True</span>)</span>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	154	</h3>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	155	</td><td align="right" valign="top"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	156	><span class="codelink"><a href="nokia.nokiaccm-pysrc.html#open_session">source code</a></span>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	157	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	158	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	159
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	160	<p>Provides a Session object.</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	161	<p>Attempts to return a Session, based either on existing Synergy
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	162	sessions or by creating a new one.</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	163	<ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	164	<li><p class="rst-first">If a .netrc file can be found on the user's personal drive,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	165	that will be read to obtain Synergy login information if it
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	166	is defined there. This will be used to fill in any missing
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	167	parameters not passed in the call to open_session().</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	168	<p>The format of the .netrc file entries should be:</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	169	<p>machine synergy login USERNAME password foobar account <a class="rst-reference external" href="mailto:DATABASE_PATH@SERVER" target="_top">DATABASE_PATH@SERVER</a></p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	170	<p>If the details refer to a specific database, the machine can be the database name,
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	171	instead of "synergy".</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	172	</li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	173	<li><p class="rst-first">If an existing session is running that matches the supplied
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	174	parameters, it will reuse that.</p>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	175	</li>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	176	</ul>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	177	<dl class="fields">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	178	</dl>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	179	</td></tr></table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	180	</div>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	181	<br />
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	182	<!-- ==================== NAVIGATION BAR ==================== -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	183	<table class="navbar" border="0" width="100%" cellpadding="0"
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	184	bgcolor="#a0c0ff" cellspacing="0">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	185	<tr valign="middle">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	186
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	187	<!-- Tree link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	188	<th>   <a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	189	href="module-tree.html">Trees</a>   </th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	190
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	191	<!-- Index link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	192	<th>   <a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	193	href="identifier-index.html">Indices</a>   </th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	194
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	195	<!-- Help link -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	196	<th>   <a
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	197	href="help.html">Help</a>   </th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	198
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	199	<th class="navbar" width="100%"></th>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	200	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	201	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	202	<table border="0" cellpadding="0" cellspacing="0" width="100%%">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	203	<tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	204	<td align="left" class="footer">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	205	Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	206	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	207	<td align="right" class="footer">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	208	<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	209	</td>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	210	</tr>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	211	</table>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	212
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	213	<script type="text/javascript">
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	214	<!--
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	215	// Private objects are initially displayed (because if
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	216	// javascript is turned off then we want them to be
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	217	// visible); but by default, we want to hide them. So hide
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	218	// them unless we have a cookie that says to show them.
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	219	checkCookie()
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	220	// -->
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	221	</script>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	222
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	223	</body>
f2ddfa555b0f Add FBF documents for default config that built PDK 2.0.e Shabe Razvi <shaber@symbian.org> parents: diff changeset	224	</html>

author	Maciej Seroka <maciejs@symbian.org>
	Wed, 11 Nov 2009 13:04:22 +0000
changeset 749	09c37dab59b4
parent 432	f2ddfa555b0f
permissions	-rw-r--r--