workbench/libs/gadtools/gt_beginrefresh.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: english
   7 */
   8 #include <proto/intuition.h>
   9 #include "gadtools_intern.h"
  10
  11 /*********************************************************************
  12
  13     NAME */
  14 #include <proto/gadtools.h>
  15 #include <intuition/intuition.h>
  16
  17         AROS_LH1(void, GT_BeginRefresh,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct Window *, win, A0),
  21
  22 /*  LOCATION */
  23         struct Library *, GadToolsBase, 15, GadTools)
  24
  25 /*  FUNCTION
  26         Refreshes the given window. This function must be used instead
  27         of BeginRefresh(), if gadtools-gadgets are used. When you are
  28         finished with refreshing the window, you must call GT_EndRefresh().
  29
  30     INPUTS
  31         win - window to refresh
  32
  33     RESULT
  34
  35     NOTES
  36         Due to the internal structure of gadtools, it is not possible
  37         to use WFLG_NOCAREREFRESH with windows, which use gadtools-
  38         gadgets.
  39         You should simple rendering functions between GT_BeginRefresh() and
  40         GT_EndRefresh() only. Do not render or change any gadgets.
  41
  42     EXAMPLE
  43         case IDCMP_REFRESHWINDOW:
  44             GT_BeginRefresh(mywin);
  45             GT_EndRefresh(mywin, TRUE);
  46
  47     BUGS
  48
  49     SEE ALSO
  50         GT_EndRefresh(), intuition.library/BeginRefresh()
  51
  52     INTERNALS
  53
  54     HISTORY
  55
  56 ***************************************************************************/
  57 {
  58     AROS_LIBFUNC_INIT
  59
  60     BeginRefresh(win);
  61
  62     AROS_LIBFUNC_EXIT
  63
  64 } /* GT_BeginRefresh */