40ab72cf825081b0da8051772036881777000b47
[vlc.git] / modules / gui / macosx / misc.h
1 /*****************************************************************************
2  * misc.h: code not specific to vlc
3  *****************************************************************************
4  * Copyright (C) 2003-2014 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8  *          Felix Paul K├╝hne <fkuehne at videolan dot org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #import <Cocoa/Cocoa.h>
26
27 /*****************************************************************************
28  * VLCDragDropView
29  *
30  * Disables default drag / drop behaviour of an NSImageView.
31  * set it for all sub image views withing an VLCDragDropView.
32  *****************************************************************************/
33
34
35 @interface VLCDropDisabledImageView : NSImageView
36
37 @end
38
39 /*****************************************************************************
40  * VLCDragDropView
41  *****************************************************************************/
42
43 @interface VLCDragDropView : NSView
44
45 @property (nonatomic, assign) id dropHandler;
46 @property (nonatomic, assign) BOOL drawBorder;
47
48 - (void)enablePlaylistItems;
49
50 @end
51
52 /*****************************************************************************
53  * VLCVolumeSliderCommon
54  *****************************************************************************/
55
56 @interface VLCVolumeSliderCommon : NSSlider
57
58 @property (readwrite, nonatomic) BOOL usesBrightArtwork;
59
60 - (void)scrollWheel:(NSEvent *)o_event;
61 - (void)drawFullVolumeMarker;
62
63 - (CGFloat)fullVolumePos;
64
65 @end
66
67 @interface VolumeSliderCell : NSSliderCell
68 @end
69
70 /*****************************************************************************
71  * ITSlider
72  *****************************************************************************/
73
74 @interface ITSlider : VLCVolumeSliderCommon
75
76 @end
77
78 /*****************************************************************************
79  * VLCMainWindowSplitView interface
80  *****************************************************************************/
81 @interface VLCMainWindowSplitView : NSSplitView
82
83 @end
84
85 /*****************************************************************************
86  * VLCThreePartImageView interface
87  *****************************************************************************/
88 @interface VLCThreePartImageView : NSView
89
90 - (void)setImagesLeft:(NSImage *)left middle: (NSImage *)middle right:(NSImage *)right;
91
92 @end
93
94
95 /*****************************************************************************
96  * PositionFormatter interface
97  *
98  * Formats a text field to only accept decimals and :
99  *****************************************************************************/
100 @interface PositionFormatter : NSFormatter
101
102 - (NSString*)stringForObjectValue:(id)obj;
103
104 - (BOOL)getObjectValue:(id*)obj
105              forString:(NSString*)string
106       errorDescription:(NSString**)error;
107
108 - (BOOL)isPartialStringValid:(NSString*)partialString
109             newEditingString:(NSString**)newString
110             errorDescription:(NSString**)error;
111
112 @end
113
114 /*****************************************************************************
115  * NSView addition
116  *****************************************************************************/
117
118 @interface NSView (EnableSubviews)
119 - (void)enableSubviews:(BOOL)b_enable;
120 @end
121
122 /*****************************************************************************
123  * VLCByteCountFormatter addition
124  *****************************************************************************/
125
126 #ifndef MAC_OS_X_VERSION_10_8
127 enum {
128     // Specifies display of file or storage byte counts. The actual behavior for this is platform-specific; on OS X 10.7 and less, this uses the binary style, but decimal style on 10.8 and above
129     NSByteCountFormatterCountStyleFile   = 0,
130     // Specifies display of memory byte counts. The actual behavior for this is platform-specific; on OS X 10.7 and less, this uses the binary style, but that may change over time.
131     NSByteCountFormatterCountStyleMemory = 1,
132     // The following two allow specifying the number of bytes for KB explicitly. It's better to use one of the above values in most cases.
133     NSByteCountFormatterCountStyleDecimal = 2,    // 1000 bytes are shown as 1 KB
134     NSByteCountFormatterCountStyleBinary  = 3     // 1024 bytes are shown as 1 KB
135 };
136 typedef NSInteger NSByteCountFormatterCountStyle;
137 #endif
138
139 @interface VLCByteCountFormatter : NSFormatter {
140 }
141
142 + (NSString *)stringFromByteCount:(long long)byteCount countStyle:(NSByteCountFormatterCountStyle)countStyle;
143 @end