.. include:: headings.inc

.. module:: lib.utils

.. currentmodule:: lib.utils

.. highlight:: python



.. _lib.utils:

==========================================================================================================================================
|phoenix_title|  **utils**
==========================================================================================================================================

A few useful functions.  (Ok, only one so far...)


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.utils.AdjustRectToScreen`                                            Compare the rect with the dinmensions of the display that the rect's
================================================================================ ================================================================================


|



Functions
------------

.. function:: AdjustRectToScreen(rect, adjust=(0,0))

   Compare the rect with the dinmensions of the display that the rect's
   upper left corner is positioned on. If it doesn't fit entirely on
   screen then attempt to make it do so either by repositioning the
   rectangle, resizing it, or both.  Returns the adjusted rectangle.
   
   If the adjustment value is given then it will be used to ensure that
   the rectangle is at least that much smaller than the display's client
   area.