modules/gui/macosx/VLCDefaultValueSlider.h

   1 /*****************************************************************************
   2  * VLCDefaultValueSlider.h: Custom NSSlider which allows a defaultValue
   3  *****************************************************************************
   4  * Copyright (C) 2016 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Marvin Scholz <epirat07 -at- gmail -dot- 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 <Cocoa/Cocoa.h>
  25
  26 /**
  27  \c VLCDefaultValueSlider is a NSSlider subclass that allows setting
  28  a \c defaultValue which gets a tickmark and the knob snaps to that
  29  default value. Additionally a VLCDefaultValueSlider can be adjusted
  30  with the mouse scroll wheel, if enabled.
  31  */
  32 @interface VLCDefaultValueSlider : NSSlider
  33
  34 /**
  35  Indicates if the slider is scrollable with the mouse or trackpad scrollwheel.
  36  */
  37 @property (readwrite) BOOL isScrollable;
  38
  39 /**
  40  Sets the default value to which the slider will snap and draw a tickmark for.
  41  To unset the defaultValue, set it to \c DBL_MAX
  42
  43  \note value must be in the value range of the slider and be smaller than \c DBL_MAX
  44
  45  \param value The default value
  46  */
  47 - (void)setDefaultValue:(double)value;
  48
  49 /**
  50  Get the default value
  51
  52  \note It the returned value is \c DBL_MAX, there is no defaultValue set.
  53  */
  54 - (double)defaultValue;
  55
  56 @end