modules/gui/macosx/VLCKeyboardBacklightControl.h

   1 /*****************************************************************************
   2  * VLCKeyboardBlacklightControl.h: MacBook keyboard backlight control for VLC
   3  *****************************************************************************
   4  * Copyright (C) 2015 VLC authors and VideoLAN
   5  *
   6  *
   7  * Authors: Maxime Mouchet <max@maxmouchet.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #import <Foundation/Foundation.h>
  25
  26 @interface VLCKeyboardBacklightControl : NSObject
  27
  28 /*!
  29  *  Initialize an instance of KeyboardBacklight.
  30  *
  31  *  Note: this will return nil if the connection to
  32  *  the controller could not be opened.
  33  */
  34 - (id)init;
  35
  36 /*!
  37  *  Smoothly turn on backlight on MacBook keyboard.
  38  *
  39  *  Try to restore the previous brightness level. If the user has put
  40  *  the backlight on manually (using hardware keys), nothing will be done.
  41  */
  42 - (void)lightsUp;
  43
  44 /*!
  45  *  Smoothly turn off backlight on MacBook keyboard.
  46  */
  47 - (void)lightsDown;
  48
  49 /*!
  50  *  Smoothly switch on or off backlight on MacBook keyboard.
  51  *  This will return immediately.
  52  */
  53 - (void)switchLightsAsync:(BOOL)on;
  54
  55 /*!
  56  *  Instantly switch on or off backlight on MacBook keyboard.
  57  */
  58 - (void)switchLightsInstantly:(BOOL)on;
  59
  60 @end