scalos/main/docs/AutoDocs/html/SCA_Window.html

   1 fileSCA_Window.docContent-Type: text/html
   2
   3
   4         <HTML><HEAD><TITLE>Window.sca</TITLE></HEAD><BODY BACKGROUND='http://scalos.striatum.org/gfx/backdrop.gif'>
   5
   6         <FONT SIZE="5"><B>Window.sca</B></FONT><P><UL>
   7         <LI><A HREF="#1">--background</A></LI><LI><A HREF="#2">SCCM_Window_ChangeWindow</A></LI><LI><A HREF="#3">SCCM_Window_Close</A></LI><LI><A HREF="#4">SCCM_Window_GetIconFileType</A></LI><LI><A HREF="#5">SCCM_Window_Iconify</A></LI><LI><A HREF="#6">SCCM_Window_InitClipRegion</A></LI><LI><A HREF="#7">SCCM_Window_LockUpdate</A></LI><LI><A HREF="#8">SCCM_Window_RemClipRegion</A></LI><LI><A HREF="#9">SCCM_Window_Open</A></LI><LI><A HREF="#10">SCCM_Window_SetTitle</A></LI><LI><A HREF="#11">SCCM_Window_SetInnerSize</A></LI><LI><A HREF="#12">SCCM_Window_UnIconify</A></LI><LI><A HREF="#13">SCCM_Window_UnlockUpdate</A></LI></UL><P><UL><UL><A NAME="1"><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>       --background<BR><BR>    DESCRIPTION<BR> This class implements all common window functionality used for icon <BR>        windows, text windows and device windows.<BR><BR>       All window methods are invoked with mt_WindowObject.<BR><BR></UL><HR><A NAME="#2"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>        SCCM_Window_ChangeWindow<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE> DoMethod(obj,SCCM_Window_ChangeWindow);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>        Notifies that a Scalos window may have changed either <BR>      position, or size, or both.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL> none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL></UL><HR><A NAME="#3"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>       SCCM_Window_Close<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>        DoMethod(obj,SCCM_Window_Close);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>       Closes a scalos window<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>      none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL></UL><HR><A NAME="#4"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>       SCCM_Window_GetIconFileType<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>      DoMethod(obj,SCCM_Window_GetIconFileType, struct ScaIconNode *in);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>     Fills the in_FileType element of the Scalos icon with a TypeNode <BR>   according to the file type of the icon.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>     in - Scalos icon that gets its in_FileType updated.<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL> nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL></UL><HR><A NAME="#5"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>       SCCM_Window_Iconify<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>      DoMethod(obj,SCCM_Window_Iconify);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>     Iconifies a scalos window<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>   none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        TRUE if window could be iconified successfully or <BR>          has already been iconified.<BR> FALSE if something went wrong.<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL></UL><HR><A NAME="#6"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>        SCCM_Window_UnIconify<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>    DoMethod(obj,SCCM_Window_UnIconify);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>   Uniconifies an iconified scalos window<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>      none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL></UL><HR><A NAME="#7"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>       SCCM_Window_InitClipRegion<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>       struct Region *oldRegion = DoMethod(obj,SCCM_Window_InitClipRegion);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>   Initializes window clip region so that all rendering is limited to<BR>  the window interior.<BR>        All window drawing - especially icon rendering - should be done <BR>    inside a SCCM_Window_InitClipRegion / SCCM_Window_RemClipRegion call.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>       none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        oldRegion - original clip region (to be supplied <BR>           to SCCM_Window_RemClipRegion)<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL>     SCCM_Window_RemClipRegion<BR></UL><HR><A NAME="#8"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>       SCCM_Window_LockUpdate<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>   void DoMethod(obj,SCCM_Window_LockUpdate)<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>      Holds all icon updates for that window.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>     none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL>   SCCM_Window_UnlockUpdate<BR></UL><HR><A NAME="#9"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>        SCCM_Window_RemClipRegion<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>        void DoMethod(obj,SCCM_Window_RemClipRegion, <BR>               struct Region *oldRegion);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>     Resets window clip region to oldRegion.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>     oldRegion - original clip region <BR>           (Result from SCCM_Window_InitClipRegion)<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>    nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL>   SCCM_Window_InitClipRegion<BR></UL><HR><A NAME="#10"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>     SCCM_Window_Open<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE> struct Window *win = DoMethod(obj,SCCM_Window_Open);<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>   Opens a scalos window<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>       none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        win - Pointer to Intuition Window if window could be opened, <BR>               NULL if something went wrong.<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL></UL><HR><A NAME="#11"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>        SCCM_Window_SetTitle<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE>     void DoMethod(obj,SCCM_Window_SetTitle, CONST_STRPTR title)<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>    Sets window title to (title).<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>       title - window title string.<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL><BR></UL><HR><A NAME="#12"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>  SCCM_Window_SetInnerSize<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE> void DoMethod(obj,SCCM_Window_SetInnerSize)<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>    Update internal Scalos variables according to the current <BR>  window size and setup a new window clip region.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>     none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL><BR></UL><HR><A NAME="#13"><BR><BR>    </LI><LI><B><FONT SIZE="4">NAME</FONT></B><UL><BR>  SCCM_Window_UnlockUpdate<BR><BR></UL><FONT SIZE="4"><B>    SYNOPSIS<BR></B></FONT><PRE> void DoMethod(obj,SCCM_Window_UnlockUpdate)<BR><BR></PRE>&nbsp;<BR><FONT SIZE="4"><B>    FUNCTION<BR></B></FONT><UL>    Enabled window updates stopped by SCCM_Window_LockUpdate.<BR><BR></UL><FONT SIZE="4"><B>    INPUTS<BR></B></FONT><UL>   none<BR><BR></UL><FONT SIZE="4"><B>    RESULT<BR></B></FONT><UL>        nothing<BR><BR></UL><FONT SIZE="4"><B>    SEE ALSO<BR></B></FONT><UL>   SCCM_Window_LockUpdate<BR></UL><HR><A NAME="#14"><BR>
   8         </LI></UL><P align="right">
   9         Generated on 12th April 2004 by ad2html.pl v0.87 by <A HREF="http://www.philprice.net" TARGET="_blank">Phil Price</A>
  10         </BODY></HTML>
  11