macOS: Move VLCTimeField out of misc
[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 /*****************************************************************************
54  * MPSlider
55  *****************************************************************************/
56
57 @interface MPSlider : NSSlider
58
59 @end
60
61 /*****************************************************************************
62  * ProgressView
63  *****************************************************************************/
64
65 @interface VLCProgressView : NSView
66
67 - (void)scrollWheel:(NSEvent *)o_event;
68
69 @end
70
71
72 /*****************************************************************************
73  * TimeLineSlider
74  *****************************************************************************/
75
76 @interface TimeLineSlider : NSSlider
77
78 @property (readonly) CGFloat knobPosition;
79
80 - (void)drawRect:(NSRect)rect;
81 - (void)drawKnobInRect:(NSRect)knobRect;
82
83 @end
84
85 /*****************************************************************************
86  * VLCVolumeSliderCommon
87  *****************************************************************************/
88
89 @interface VLCVolumeSliderCommon : NSSlider
90
91 @property (readwrite, nonatomic) BOOL usesBrightArtwork;
92
93 - (void)scrollWheel:(NSEvent *)o_event;
94 - (void)drawFullVolumeMarker;
95
96 - (CGFloat)fullVolumePos;
97
98 @end
99
100 @interface VolumeSliderCell : NSSliderCell
101 @end
102
103 /*****************************************************************************
104  * ITSlider
105  *****************************************************************************/
106
107 @interface ITSlider : VLCVolumeSliderCommon
108
109 @end
110
111 /*****************************************************************************
112  * VLCMainWindowSplitView interface
113  *****************************************************************************/
114 @interface VLCMainWindowSplitView : NSSplitView
115
116 @end
117
118 /*****************************************************************************
119  * VLCThreePartImageView interface
120  *****************************************************************************/
121 @interface VLCThreePartImageView : NSView
122
123 - (void)setImagesLeft:(NSImage *)left middle: (NSImage *)middle right:(NSImage *)right;
124
125 @end
126
127
128 /*****************************************************************************
129  * PositionFormatter interface
130  *
131  * Formats a text field to only accept decimals and :
132  *****************************************************************************/
133 @interface PositionFormatter : NSFormatter
134
135 - (NSString*)stringForObjectValue:(id)obj;
136
137 - (BOOL)getObjectValue:(id*)obj
138              forString:(NSString*)string
139       errorDescription:(NSString**)error;
140
141 - (BOOL)isPartialStringValid:(NSString*)partialString
142             newEditingString:(NSString**)newString
143             errorDescription:(NSString**)error;
144
145 @end
146
147 /*****************************************************************************
148  * NSView addition
149  *****************************************************************************/
150
151 @interface NSView (EnableSubviews)
152 - (void)enableSubviews:(BOOL)b_enable;
153 @end
154
155 /*****************************************************************************
156  * VLCByteCountFormatter addition
157  *****************************************************************************/
158
159 #ifndef MAC_OS_X_VERSION_10_8
160 enum {
161     // 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
162     NSByteCountFormatterCountStyleFile   = 0,
163     // 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.
164     NSByteCountFormatterCountStyleMemory = 1,
165     // 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.
166     NSByteCountFormatterCountStyleDecimal = 2,    // 1000 bytes are shown as 1 KB
167     NSByteCountFormatterCountStyleBinary  = 3     // 1024 bytes are shown as 1 KB
168 };
169 typedef NSInteger NSByteCountFormatterCountStyle;
170 #endif
171
172 @interface VLCByteCountFormatter : NSFormatter {
173 }
174
175 + (NSString *)stringFromByteCount:(long long)byteCount countStyle:(NSByteCountFormatterCountStyle)countStyle;
176 @end