sam-t2/devtools/v9/html/python/mac/scrolledwindow-object.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="mac.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="mac.html" title='Macintosh Library Modules' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="dialogwindow-objects.html" />
<link rel="prev" href="controlswindow-object.html" />
<link rel="parent" href="module-FrameWork.html" />
<link rel="next" href="dialogwindow-objects.html" />
<meta name='aesop' content='information' />
<title>2.8.4 ScrolledWindow Object </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2.8.3 ControlsWindow Object"
  href="controlswindow-object.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="2.8 FrameWork  "
  href="module-FrameWork.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2.8.5 DialogWindow Objects"
  href="dialogwindow-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Macintosh Library Modules</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="controlswindow-object.html">2.8.3 ControlsWindow Object</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-FrameWork.html">2.8 FrameWork  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="dialogwindow-objects.html">2.8.5 DialogWindow Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION004840000000000000000"></A><A NAME="scrolledwindow-object"></A>
<BR>
2.8.4 ScrolledWindow Object
</H2>

<P>
ScrolledWindow objects are ControlsWindow objects with the following
extra methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-124' xml:id='l2h-124' class="method">scrollbars</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>wantx</var><big>[</big><var>,
                                               wanty</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Create (or destroy) horizontal and vertical scrollbars. The arguments
specify which you want (default: both). The scrollbars always have
minimum <code>0</code> and maximum <code>32767</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-125' xml:id='l2h-125' class="method">getscrollbarvalues</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
You must supply this method. It should return a tuple <code>(<var>x</var>,
<var>y</var>)</code> giving the current position of the scrollbars (between
<code>0</code> and <code>32767</code>). You can return <code>None</code> for either to
indicate the whole document is visible in that direction.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-126' xml:id='l2h-126' class="method">updatescrollbars</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Call this method when the document has changed. It will call
<tt class="method">getscrollbarvalues()</tt> and update the scrollbars.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-127' xml:id='l2h-127' class="method">scrollbar_callback</tt></b>(</nobr></td>
  <td><var>which, what, value</var>)</td></tr></table></dt>
<dd>
Supplied by you and called after user interaction. <var>which</var> will
be <code>'x'</code> or <code>'y'</code>, <var>what</var> will be <code>'-'</code>,
<code>'-&#45;'</code>, <code>'set'</code>, <code>'++'</code> or <code>'+'</code>. For
<code>'set'</code>, <var>value</var> will contain the new scrollbar position.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-128' xml:id='l2h-128' class="method">scalebarvalues</tt></b>(</nobr></td>
  <td><var>absmin, absmax,
                                                   curmin, curmax</var>)</td></tr></table></dt>
<dd>
Auxiliary method to help you calculate values to return from
<tt class="method">getscrollbarvalues()</tt>. You pass document minimum and maximum value
and topmost (leftmost) and bottommost (rightmost) visible values and
it returns the correct number or <code>None</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-129' xml:id='l2h-129' class="method">do_activate</tt></b>(</nobr></td>
  <td><var>onoff, event</var>)</td></tr></table></dt>
<dd>
Takes care of dimming/highlighting scrollbars when a window becomes
frontmost. If you override this method, call this one at the end of
your method.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-130' xml:id='l2h-130' class="method">do_postresize</tt></b>(</nobr></td>
  <td><var>width, height, window</var>)</td></tr></table></dt>
<dd>
Moves scrollbars to the correct position. Call this method initially
if you override it.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-131' xml:id='l2h-131' class="method">do_controlhit</tt></b>(</nobr></td>
  <td><var>window, control,
                                                  pcode, event</var>)</td></tr></table></dt>
<dd>
Handles scrollbar interaction. If you override it call this method
first, a nonzero return value indicates the hit was in the scrollbars
and has been handled.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2.8.3 ControlsWindow Object"
  href="controlswindow-object.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="2.8 FrameWork  "
  href="module-FrameWork.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2.8.5 DialogWindow Objects"
  href="dialogwindow-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Macintosh Library Modules</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="controlswindow-object.html">2.8.3 ControlsWindow Object</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-FrameWork.html">2.8 FrameWork  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="dialogwindow-objects.html">2.8.5 DialogWindow Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>