src/xaut_display.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Chris Parker                                    *
   3  *   chrsprkr3@gmail.com                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the Python License version 2.5 or later.        *
   7  *                                                                         *
   8  *   This program is distributed in the hope that it will be useful,       *
   9  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  10  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  11  ***************************************************************************/
  12
  13 /*
  14 $URL$
  15 $Author$
  16 $Date$
  17 $Rev$
  18 */
  19
  20 #ifndef XAUT_DISPLAY_H_
  21 #define XAUT_DISPLAY_H_
  22
  23 #include "xaut.h"
  24
  25 /**
  26  * Returns the height of the screen in pixels.
  27  * @return the display height of the screen in pixels
  28  */
  29 int display_h();
  30
  31 /**
  32  * Returns the width of the screen in pixels.
  33  * @return the display width of the screen in pixels
  34  */
  35 int display_w();
  36
  37 /**
  38  * Returns the number of virtual desktops.
  39  * @return the desktop count.
  40  */
  41 long desktop_count();
  42
  43 /**
  44  * Sets/gets the desktop.
  45  * If desk > -1, then switches to the desktop.
  46  * Regardless, the function always returns the current
  47  * desktop.
  48  * @param desk the desired desktop or -1 if no change required
  49  * @return the current desktop
  50  */
  51 long desktop(long desk);
  52
  53 /**
  54  * Returns the current desktop.
  55  * @return the current desktop.
  56  */
  57 long get_current_desktop();
  58
  59 /**
  60  * Sets the current desktop.
  61  * @param zero based desktop number
  62  * @return boolean indication of success.
  63  */
  64 BOOL set_current_desktop(long window_desktop);
  65
  66 extern void logit(int, char*, ...);
  67 #endif /* XAUT_DISPLAY_H_ */