1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (c) 2004-2006 Novell, Inc.
23 // Peter Bartok pbartok@novell.com
24 // Sebastien Pouliot sebastien@ximian.com
30 using System.Threading;
31 using System.Runtime.InteropServices;
33 namespace System.Windows.Forms {
34 internal abstract class XplatUIDriver {
35 internal abstract IntPtr InitializeDriver();
36 internal abstract void ShutdownDriver(IntPtr token);
37 internal delegate IntPtr WndProc(IntPtr hwnd, Msg msg, IntPtr wParam, IntPtr lParam);
40 #region XplatUI Driver Properties
41 internal virtual Color ForeColor {
43 return ThemeEngine.Current.DefaultWindowForeColor;
47 internal virtual Color BackColor {
49 return ThemeEngine.Current.DefaultWindowBackColor;
53 internal virtual Size Border3DSize {
55 return new Size (2, 2);
59 internal virtual Size BorderSize {
61 return new Size (1, 1);
65 internal virtual Size CaptionButtonSize {
67 return new Size (18, 18);
71 internal virtual Size DoubleClickSize {
73 return new Size (4, 4);
77 internal virtual int DoubleClickTime {
83 internal virtual Size FixedFrameBorderSize {
85 return new Size (3, 3);
89 internal virtual Font Font {
91 return ThemeEngine.Current.DefaultFont;
95 internal virtual Keys ModifierKeys {
101 internal virtual MouseButtons MouseButtons {
103 return MouseButtons.None;
107 internal virtual Size MouseHoverSize {
109 return new Size (1, 1);
113 internal virtual int MouseHoverTime {
119 internal virtual int MouseWheelScrollDelta {
125 internal virtual Point MousePosition {
131 internal virtual int MenuHeight {
137 internal virtual bool DropTarget {
146 internal virtual int HorizontalScrollBarHeight {
152 internal virtual bool UserClipWontExposeParent {
158 internal virtual int VerticalScrollBarWidth {
164 internal abstract int CaptionHeight { get; }
165 internal abstract Size CursorSize { get; }
166 internal abstract bool DragFullWindows { get; }
167 internal abstract Size DragSize { get; }
168 internal abstract Size FrameBorderSize { get; }
169 internal abstract Size IconSize { get; }
170 internal abstract Size MaxWindowTrackSize { get; }
171 internal abstract bool MenuAccessKeysUnderlined { get; }
172 internal abstract Size MinimizedWindowSize { get; }
173 internal abstract Size MinimizedWindowSpacingSize { get; }
174 internal abstract Size MinimumWindowSize { get; }
175 internal abstract Size MinWindowTrackSize { get; }
176 internal abstract Size SmallIconSize { get; }
177 internal abstract int MouseButtonCount { get; }
178 internal abstract bool MouseButtonsSwapped { get; }
179 internal abstract bool MouseWheelPresent { get; }
180 internal abstract Rectangle VirtualScreen { get; }
181 internal abstract Rectangle WorkingArea { get; }
182 internal abstract bool ThemesEnabled { get; }
184 #endregion // XplatUI Driver Properties
186 internal abstract event EventHandler Idle;
188 #region XplatUI Driver Methods
189 internal abstract void AudibleAlert();
191 internal abstract void EnableThemes();
193 internal abstract void GetDisplaySize(out Size size);
195 internal abstract IntPtr CreateWindow(CreateParams cp);
196 internal abstract IntPtr CreateWindow(IntPtr Parent, int X, int Y, int Width, int Height);
197 internal abstract void DestroyWindow(IntPtr handle);
199 internal abstract FormWindowState GetWindowState(IntPtr handle);
200 internal abstract void SetWindowState(IntPtr handle, FormWindowState state);
201 internal abstract void SetWindowMinMax(IntPtr handle, Rectangle maximized, Size min, Size max);
203 internal abstract void SetWindowStyle(IntPtr handle, CreateParams cp);
205 internal abstract double GetWindowTransparency(IntPtr handle);
206 internal abstract void SetWindowTransparency(IntPtr handle, double transparency, Color key);
207 internal abstract TransparencySupport SupportsTransparency();
209 internal virtual void SetAllowDrop (IntPtr handle, bool value)
211 Console.Error.WriteLine ("Drag and Drop is currently " +
212 "not supported on this platform");
215 internal virtual DragDropEffects StartDrag(IntPtr handle, object data, DragDropEffects allowedEffects) {
216 Console.Error.WriteLine ("Drag and Drop is currently " +
217 "not supported on this platform");
218 return DragDropEffects.None;
221 internal abstract void SetBorderStyle(IntPtr handle, FormBorderStyle border_style);
222 internal abstract void SetMenu(IntPtr handle, Menu menu);
224 internal abstract bool GetText(IntPtr handle, out string text);
225 internal abstract bool Text(IntPtr handle, string text);
226 internal abstract bool SetVisible(IntPtr handle, bool visible, bool activate);
227 internal abstract bool IsVisible(IntPtr handle);
228 internal abstract bool IsEnabled(IntPtr handle);
229 internal abstract IntPtr SetParent(IntPtr handle, IntPtr parent);
230 internal abstract IntPtr GetParent(IntPtr handle);
232 internal abstract void UpdateWindow(IntPtr handle);
233 internal abstract PaintEventArgs PaintEventStart(IntPtr handle, bool client);
234 internal abstract void PaintEventEnd(IntPtr handle, bool client);
236 internal abstract void SetWindowPos(IntPtr handle, int x, int y, int width, int height);
237 internal abstract void GetWindowPos(IntPtr handle, bool is_toplevel, out int x, out int y, out int width, out int height, out int client_width, out int client_height);
238 internal abstract void Activate(IntPtr handle);
239 internal abstract void EnableWindow(IntPtr handle, bool Enable);
240 internal abstract void SetModal(IntPtr handle, bool Modal);
241 internal abstract void Invalidate(IntPtr handle, Rectangle rc, bool clear);
242 internal abstract void InvalidateNC(IntPtr handle);
243 internal abstract IntPtr DefWndProc(ref Message msg);
244 internal abstract void HandleException(Exception e);
245 internal abstract void DoEvents();
246 internal abstract bool PeekMessage(Object queue_id, ref MSG msg, IntPtr hWnd, int wFilterMin, int wFilterMax, uint flags);
247 internal abstract void PostQuitMessage(int exitCode);
248 internal abstract bool GetMessage(object queue_id, ref MSG msg, IntPtr hWnd, int wFilterMin, int wFilterMax);
249 internal abstract bool TranslateMessage(ref MSG msg);
250 internal abstract IntPtr DispatchMessage(ref MSG msg);
252 internal abstract bool SetZOrder(IntPtr hWnd, IntPtr AfterhWnd, bool Top, bool Bottom);
253 internal abstract bool SetTopmost(IntPtr hWnd, bool Enabled);
254 internal abstract bool SetOwner(IntPtr hWnd, IntPtr hWndOwner);
256 internal abstract bool CalculateWindowRect(ref Rectangle ClientRect, CreateParams cp, Menu menu, out Rectangle WindowRect);
258 internal abstract Region GetClipRegion(IntPtr hwnd);
259 internal abstract void SetClipRegion(IntPtr hwnd, Region region);
261 internal abstract void SetCursor(IntPtr hwnd, IntPtr cursor);
262 internal abstract void ShowCursor(bool show);
263 internal abstract void OverrideCursor(IntPtr cursor);
264 internal abstract IntPtr DefineCursor(Bitmap bitmap, Bitmap mask, Color cursor_pixel, Color mask_pixel, int xHotSpot, int yHotSpot);
265 internal abstract IntPtr DefineStdCursor(StdCursor id);
266 internal abstract Bitmap DefineStdCursorBitmap(StdCursor id);
267 internal abstract void DestroyCursor(IntPtr cursor);
268 internal abstract void GetCursorInfo(IntPtr cursor, out int width, out int height, out int hotspot_x, out int hotspot_y);
270 internal abstract void GetCursorPos(IntPtr hwnd, out int x, out int y);
271 internal abstract void SetCursorPos(IntPtr hwnd, int x, int y);
273 internal abstract void ScreenToClient(IntPtr hwnd, ref int x, ref int y);
274 internal abstract void ClientToScreen(IntPtr hwnd, ref int x, ref int y);
276 internal abstract void GrabWindow(IntPtr hwnd, IntPtr ConfineToHwnd);
277 internal abstract void GrabInfo(out IntPtr hwnd, out bool GrabConfined, out Rectangle GrabArea);
278 internal abstract void UngrabWindow(IntPtr hwnd);
280 internal abstract void SendAsyncMethod (AsyncMethodData method);
281 internal abstract void SetTimer (Timer timer);
282 internal abstract void KillTimer (Timer timer);
284 internal abstract void CreateCaret(IntPtr hwnd, int width, int height);
285 internal abstract void DestroyCaret(IntPtr hwnd);
286 internal abstract void SetCaretPos(IntPtr hwnd, int x, int y);
287 internal abstract void CaretVisible(IntPtr hwnd, bool visible);
289 internal abstract IntPtr GetFocus();
290 internal abstract void SetFocus(IntPtr hwnd);
291 internal abstract IntPtr GetActive();
293 internal abstract void ScrollWindow(IntPtr hwnd, Rectangle rectangle, int XAmount, int YAmount, bool with_children);
294 internal abstract void ScrollWindow(IntPtr hwnd, int XAmount, int YAmount, bool with_children);
296 internal abstract bool GetFontMetrics(Graphics g, Font font, out int ascent, out int descent);
298 internal abstract bool SystrayAdd(IntPtr hwnd, string tip, Icon icon, out ToolTip tt);
299 internal abstract bool SystrayChange(IntPtr hwnd, string tip, Icon icon, ref ToolTip tt);
300 internal abstract void SystrayRemove(IntPtr hwnd, ref ToolTip tt);
302 internal abstract void SystrayBalloon(IntPtr hwnd, int timeout, string title, string text, ToolTipIcon icon);
305 internal abstract Point GetMenuOrigin(IntPtr hwnd);
306 internal abstract void MenuToScreen(IntPtr hwnd, ref int x, ref int y);
307 internal abstract void ScreenToMenu(IntPtr hwnd, ref int x, ref int y);
309 internal abstract void SetIcon(IntPtr handle, Icon icon);
311 internal abstract void ClipboardClose(IntPtr handle);
312 internal abstract IntPtr ClipboardOpen (bool primary_selection);
313 internal abstract int ClipboardGetID(IntPtr handle, string format);
314 internal abstract void ClipboardStore(IntPtr handle, object obj, int id, XplatUI.ObjectToClipboard converter);
315 internal abstract int[] ClipboardAvailableFormats(IntPtr handle);
316 internal abstract object ClipboardRetrieve(IntPtr handle, int id, XplatUI.ClipboardToObject converter);
318 internal abstract void DrawReversibleLine(Point start, Point end, Color backColor);
319 internal abstract void DrawReversibleRectangle(IntPtr handle, Rectangle rect, int line_width);
320 internal abstract void FillReversibleRectangle (Rectangle rectangle, Color backColor);
321 internal abstract void DrawReversibleFrame (Rectangle rectangle, Color backColor, FrameStyle style);
323 internal abstract SizeF GetAutoScaleSize(Font font);
325 internal abstract IntPtr SendMessage(IntPtr hwnd, Msg message, IntPtr wParam, IntPtr lParam);
326 internal abstract bool PostMessage(IntPtr hwnd, Msg message, IntPtr wParam, IntPtr lParam);
327 internal abstract int SendInput(IntPtr hwnd, System.Collections.Queue keys);
329 internal abstract object StartLoop(Thread thread);
330 internal abstract void EndLoop(Thread thread);
332 internal abstract void RequestNCRecalc(IntPtr hwnd);
333 internal abstract void ResetMouseHover(IntPtr hwnd);
334 internal abstract void RequestAdditionalWM_NCMessages(IntPtr hwnd, bool hover, bool leave);
336 // System information
337 internal abstract int KeyboardSpeed { get; }
338 internal abstract int KeyboardDelay { get; }
342 internal virtual void CreateOffscreenDrawable (IntPtr handle,
343 int width, int height,
344 out object offscreen_drawable)
346 Bitmap bmp = new Bitmap (width, height, System.Drawing.Imaging.PixelFormat.Format32bppArgb);
348 offscreen_drawable = bmp;
351 internal virtual void DestroyOffscreenDrawable (object offscreen_drawable)
353 Bitmap bmp = (Bitmap)offscreen_drawable;
358 internal virtual Graphics GetOffscreenGraphics (object offscreen_drawable)
360 Bitmap bmp = (Bitmap)offscreen_drawable;
361 return Graphics.FromImage (bmp);
364 internal virtual void BlitFromOffscreen (IntPtr dest_handle,
366 object offscreen_drawable,
367 Graphics offscreen_dc,
370 dest_dc.DrawImage ((Bitmap)offscreen_drawable, r, r, GraphicsUnit.Pixel);
373 #endregion // XplatUI Driver Methods
376 internal class XplatUIDriverSupport {
377 #region XplatUI Driver Support Methods
379 internal static void ExecutionCallback (object state)
381 AsyncMethodData data = (AsyncMethodData) state;
382 AsyncMethodResult result = data.Result;
383 object ret = data.Method.DynamicInvoke (data.Args);
384 if (result != null) {
385 result.Complete (ret);
389 internal static void ExecuteClientMessage (GCHandle gchandle)
391 AsyncMethodData data = (AsyncMethodData) gchandle.Target;
393 if (data.Context == null) {
394 ExecutionCallback (data);
396 ExecutionContext.Run (data.Context, new ContextCallback (ExecutionCallback), data);
404 // for NET_1_0 and NET_1_1 no (public) ExecutionContext exists
405 // so we must use the System.Threading.CompressedStack class
406 internal static void ExecuteClientMessage (GCHandle gchandle) {
407 AsyncMethodData data = (AsyncMethodData) gchandle.Target;
408 CompressedStack original = null;
410 #if !MWF_ON_MSRUNTIME
411 // Stack is non-null only if the security manager is active
412 if (data.Stack != null) {
413 original = Thread.CurrentThread.GetCompressedStack ();
414 Thread.CurrentThread.SetCompressedStack (data.Stack);
419 AsyncMethodResult result = data.Result;
420 object ret = data.Method.DynamicInvoke (data.Args);
421 result.Complete (ret);
424 #if !MWF_ON_MSRUNTIME
425 if (data.Stack != null) {
426 // whatever occurs we must revert to the original compressed
427 // stack (null being a valid, empty, value in this case).
428 Thread.CurrentThread.SetCompressedStack (original);
436 #endregion // XplatUI Driver Support Methods