mcs/class/Managed.Windows.Forms/System.Windows.Forms/XplatUIDriver.cs

   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:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  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.
  19 //
  20 // Copyright (c) 2004-2006 Novell, Inc.
  21 //
  22 // Authors:
  23 //      Peter Bartok            pbartok@novell.com
  24 //      Sebastien Pouliot       sebastien@ximian.com
  25 //
  26
  27 // COMPLETE
  28
  29 using System.Drawing;
  30 using System.Threading;
  31 using System.Runtime.InteropServices;
  32
  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);
  38
  39
  40                 #region XplatUI Driver Properties
  41                 internal virtual int ActiveWindowTrackingDelay { get { return 0; } }
  42
  43                 internal virtual Color ForeColor {
  44                         get {
  45                                 return ThemeEngine.Current.DefaultWindowForeColor;
  46                         }
  47                 }
  48
  49                 internal virtual  Color BackColor {
  50                         get {
  51                                 return ThemeEngine.Current.DefaultWindowBackColor;
  52                         }
  53                 }
  54
  55                 internal virtual Size Border3DSize {
  56                         get {
  57                                 return new Size (2, 2);
  58                         }
  59                 }
  60
  61                 internal virtual Size BorderSize {
  62                         get {
  63                                 return new Size (1, 1);
  64                         }
  65                 }
  66
  67                 internal virtual Size CaptionButtonSize {
  68                         get {
  69                                 return new Size (18, 18);
  70                         }
  71                 }
  72
  73                 internal virtual int CaretBlinkTime { get { return 530; } }
  74                 internal virtual int CaretWidth { get { return 10; } }
  75
  76                 internal virtual Size DoubleClickSize {
  77                         get {
  78                                 return new Size (4, 4);
  79                         }
  80                 }
  81
  82                 internal virtual int DoubleClickTime {
  83                         get {
  84                                 return 500;
  85                         }
  86                 }
  87
  88                 internal virtual Size FixedFrameBorderSize {
  89                         get {
  90                                 return new Size (3, 3);
  91                         }
  92                 }
  93
  94                 internal virtual Font Font {
  95                         get {
  96                                 return ThemeEngine.Current.DefaultFont;
  97                         }
  98                 }
  99
 100                 internal virtual int FontSmoothingContrast { get { return 1400; } }
 101                 internal virtual int FontSmoothingType { get { return 1; } }
 102                 internal virtual int HorizontalResizeBorderThickness { get { return 8; } }
 103                 internal virtual bool IsActiveWindowTrackingEnabled { get { return false; } }
 104                 internal virtual bool IsComboBoxAnimationEnabled { get { return false; } }
 105                 internal virtual bool IsDropShadowEnabled { get { return false; } }
 106                 internal virtual bool IsFontSmoothingEnabled { get { return true; } }
 107                 internal virtual bool IsHotTrackingEnabled { get { return false; } }
 108                 internal virtual bool IsIconTitleWrappingEnabled { get { return true; } }
 109                 internal virtual bool IsKeyboardPreferred { get { return false; } }
 110                 internal virtual bool IsListBoxSmoothScrollingEnabled { get { return true; } }
 111                 internal virtual bool IsMenuAnimationEnabled { get { return false; } }
 112                 internal virtual bool IsMenuFadeEnabled { get { return true; } }
 113                 internal virtual bool IsMinimizeRestoreAnimationEnabled { get { return false; } }
 114                 internal virtual bool IsSelectionFadeEnabled { get { return false; } }
 115                 internal virtual bool IsSnapToDefaultEnabled { get { return false; } }
 116                 internal virtual bool IsTitleBarGradientEnabled { get { return false; } }
 117                 internal virtual bool IsToolTipAnimationEnabled { get { return false; } }
 118                 internal virtual Size MenuBarButtonSize { get { return new Size (19, 19); } }
 119                 public virtual Size MenuButtonSize {
 120                         get {
 121                                 return new Size(18, 18);
 122                         }
 123                 }
 124                 internal virtual int MenuShowDelay { get { return 0; } }
 125
 126                 internal virtual Keys ModifierKeys {
 127                         get {
 128                                 return Keys.None;
 129                         }
 130                 }
 131
 132                 internal virtual MouseButtons MouseButtons {
 133                         get {
 134                                 return MouseButtons.None;
 135                         }
 136                 }
 137
 138                 internal virtual Size MouseHoverSize {
 139                         get {
 140                                 return new Size (1, 1);
 141                         }
 142                 }
 143
 144                 internal virtual int MouseHoverTime {
 145                         get {
 146                                 return 500;
 147                         }
 148                 }
 149
 150                 internal virtual int MouseSpeed {
 151                         get { return 10; }
 152                 }
 153
 154                 internal virtual int MouseWheelScrollDelta {
 155                         get {
 156                                 return 120;
 157                         }
 158                 }
 159
 160                 internal virtual Point MousePosition {
 161                         get {
 162                                 return Point.Empty;
 163                         }
 164                 }
 165
 166                 internal virtual int MenuHeight {
 167                         get {
 168                                 return 19;
 169                         }
 170                 }
 171
 172                 internal virtual LeftRightAlignment PopupMenuAlignment {
 173                         get { return LeftRightAlignment.Left; }
 174                 }
 175
 176                 internal virtual PowerStatus PowerStatus {
 177                         get { throw new NotImplementedException ("Has not been implemented yet for this platform."); }
 178                 }
 179
 180                 internal virtual int SizingBorderWidth {
 181                         get { return 4; }
 182                 }
 183
 184                 internal virtual Size SmallCaptionButtonSize {
 185                         get { return new Size (15, 15); }
 186                 }
 187
 188                 internal virtual bool UIEffectsEnabled {
 189                         get { return false; }
 190                 }
 191
 192                 internal virtual bool DropTarget {
 193                         get {
 194                                 return false;
 195                         }
 196
 197                         set {
 198                         }
 199                 }
 200
 201                 internal virtual int HorizontalScrollBarHeight {
 202                         get {
 203                                 return 16;
 204                         }
 205                 }
 206
 207                 internal virtual bool UserClipWontExposeParent {
 208                         get {
 209                                 return true;
 210                         }
 211                 }
 212
 213                 internal virtual int VerticalResizeBorderThickness { get { return 8; } }
 214
 215                 internal virtual int VerticalScrollBarWidth {
 216                         get {
 217                                 return 16;
 218                         }
 219                 }
 220
 221                 internal abstract int CaptionHeight { get; }
 222                 internal abstract Size CursorSize { get; }
 223                 internal abstract bool DragFullWindows { get; }
 224                 internal abstract Size DragSize { get; }
 225                 internal abstract Size FrameBorderSize { get; }
 226                 internal abstract Size IconSize { get; }
 227                 internal abstract Size MaxWindowTrackSize { get; }
 228                 internal abstract bool MenuAccessKeysUnderlined { get; }
 229                 internal virtual Size MinimizedWindowSize {
 230                         get {
 231                                 const int BorderWidth = 3;
 232                                 return new Size (154 + 2 * BorderWidth, SystemInformation.CaptionHeight + 2 * BorderWidth - 1);
 233                         }
 234                 }
 235                 internal abstract Size MinimizedWindowSpacingSize { get; }
 236                 internal abstract Size MinimumWindowSize { get; }
 237                 internal virtual Size MinimumFixedToolWindowSize { get { return Size.Empty; } }
 238                 internal virtual Size MinimumSizeableToolWindowSize { get { return Size.Empty; } }
 239                 internal virtual Size MinimumNoBorderWindowSize { get { return Size.Empty; } }
 240                 internal virtual Size MinWindowTrackSize {
 241                         get {
 242                                 return new Size (112, 27);
 243                         }
 244                 }
 245                 internal abstract Size SmallIconSize { get; }
 246                 internal abstract int MouseButtonCount { get; }
 247                 internal abstract bool MouseButtonsSwapped { get; }
 248                 internal abstract bool MouseWheelPresent { get; }
 249                 internal abstract Rectangle VirtualScreen { get; }
 250                 internal abstract Rectangle WorkingArea { get; }
 251                 internal abstract bool ThemesEnabled { get; }
 252
 253                 internal virtual bool RequiresPositiveClientAreaSize {
 254                         get {
 255                                 return true;
 256                         }
 257                 }
 258
 259                 public virtual int ToolWindowCaptionHeight {
 260                         get {
 261                                 return 16;
 262                         }
 263                 }
 264
 265                 public virtual Size ToolWindowCaptionButtonSize {
 266                         get {
 267                                 return new Size (15, 15);
 268                         }
 269                 }
 270                 #endregion      // XplatUI Driver Properties
 271
 272                 internal abstract event EventHandler Idle;
 273
 274                 #region XplatUI Driver Methods
 275                 internal abstract void AudibleAlert(AlertType alert);
 276
 277                 internal abstract void BeginMoveResize (IntPtr handle); // init a window manager driven resize event
 278
 279                 internal abstract void EnableThemes();
 280
 281                 internal abstract void GetDisplaySize(out Size size);
 282
 283                 internal abstract IntPtr CreateWindow(CreateParams cp);
 284                 internal abstract IntPtr CreateWindow(IntPtr Parent, int X, int Y, int Width, int Height);
 285                 internal abstract void DestroyWindow(IntPtr handle);
 286
 287                 internal abstract FormWindowState GetWindowState(IntPtr handle);
 288                 internal abstract void SetWindowState(IntPtr handle, FormWindowState state);
 289                 internal abstract void SetWindowMinMax(IntPtr handle, Rectangle maximized, Size min, Size max);
 290
 291                 internal abstract void SetWindowStyle(IntPtr handle, CreateParams cp);
 292
 293                 internal abstract double GetWindowTransparency(IntPtr handle);
 294                 internal abstract void SetWindowTransparency(IntPtr handle, double transparency, Color key);
 295                 internal abstract TransparencySupport SupportsTransparency();
 296
 297                 internal virtual void SetAllowDrop (IntPtr handle, bool value)
 298                 {
 299                         Console.Error.WriteLine ("Drag and Drop is currently " +
 300                                         "not supported on this platform");
 301                 }
 302
 303                 internal virtual DragDropEffects StartDrag(IntPtr handle, object data, DragDropEffects allowedEffects) {
 304                         Console.Error.WriteLine ("Drag and Drop is currently " +
 305                                         "not supported on this platform");
 306                         return DragDropEffects.None;
 307                 }
 308
 309                 internal abstract void SetBorderStyle(IntPtr handle, FormBorderStyle border_style);
 310                 internal abstract void SetMenu(IntPtr handle, Menu menu);
 311
 312                 internal abstract bool GetText(IntPtr handle, out string text);
 313                 internal abstract bool Text(IntPtr handle, string text);
 314                 internal abstract bool SetVisible(IntPtr handle, bool visible, bool activate);
 315                 internal abstract bool IsVisible(IntPtr handle);
 316                 internal abstract bool IsEnabled(IntPtr handle);
 317                 internal virtual bool IsKeyLocked (VirtualKeys key) { return false; }
 318                 internal abstract IntPtr SetParent(IntPtr handle, IntPtr parent);
 319                 internal abstract IntPtr GetParent(IntPtr handle);
 320
 321                 internal abstract void UpdateWindow(IntPtr handle);
 322                 internal abstract PaintEventArgs PaintEventStart (ref Message msg, IntPtr handle, bool client);
 323                 internal abstract void PaintEventEnd (ref Message msg, IntPtr handle, bool client);
 324
 325                 internal abstract void SetWindowPos(IntPtr handle, int x, int y, int width, int height);
 326                 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);
 327                 internal abstract void Activate(IntPtr handle);
 328                 internal abstract void EnableWindow(IntPtr handle, bool Enable);
 329                 internal abstract void SetModal(IntPtr handle, bool Modal);
 330                 internal abstract void Invalidate(IntPtr handle, Rectangle rc, bool clear);
 331                 internal abstract void InvalidateNC(IntPtr handle);
 332                 internal abstract IntPtr DefWndProc(ref Message msg);
 333                 internal abstract void HandleException(Exception e);
 334                 internal abstract void DoEvents();
 335                 internal abstract bool PeekMessage(Object queue_id, ref MSG msg, IntPtr hWnd, int wFilterMin, int wFilterMax, uint flags);
 336                 internal abstract void PostQuitMessage(int exitCode);
 337                 internal abstract bool GetMessage(object queue_id, ref MSG msg, IntPtr hWnd, int wFilterMin, int wFilterMax);
 338                 internal abstract bool TranslateMessage(ref MSG msg);
 339                 internal abstract IntPtr DispatchMessage(ref MSG msg);
 340
 341                 internal abstract bool SetZOrder(IntPtr hWnd, IntPtr AfterhWnd, bool Top, bool Bottom);
 342                 internal abstract bool SetTopmost(IntPtr hWnd, bool Enabled);
 343                 internal abstract bool SetOwner(IntPtr hWnd, IntPtr hWndOwner);
 344
 345                 internal abstract bool CalculateWindowRect(ref Rectangle ClientRect, CreateParams cp, Menu menu, out Rectangle WindowRect);
 346
 347                 internal abstract Region GetClipRegion(IntPtr hwnd);
 348                 internal abstract void SetClipRegion(IntPtr hwnd, Region region);
 349
 350                 internal abstract void SetCursor(IntPtr hwnd, IntPtr cursor);
 351                 internal abstract void ShowCursor(bool show);
 352                 internal abstract void OverrideCursor(IntPtr cursor);
 353                 internal abstract IntPtr DefineCursor(Bitmap bitmap, Bitmap mask, Color cursor_pixel, Color mask_pixel, int xHotSpot, int yHotSpot);
 354                 internal abstract IntPtr DefineStdCursor(StdCursor id);
 355                 internal abstract Bitmap DefineStdCursorBitmap(StdCursor id);
 356                 internal abstract void DestroyCursor(IntPtr cursor);
 357                 internal abstract void GetCursorInfo(IntPtr cursor, out int width, out int height, out int hotspot_x, out int hotspot_y);
 358
 359                 internal abstract void GetCursorPos(IntPtr hwnd, out int x, out int y);
 360                 internal abstract void SetCursorPos(IntPtr hwnd, int x, int y);
 361
 362                 internal abstract void ScreenToClient(IntPtr hwnd, ref int x, ref int y);
 363                 internal abstract void ClientToScreen(IntPtr hwnd, ref int x, ref int y);
 364
 365                 internal abstract void GrabWindow(IntPtr hwnd, IntPtr ConfineToHwnd);
 366                 internal abstract void GrabInfo(out IntPtr hwnd, out bool GrabConfined, out Rectangle GrabArea);
 367                 internal abstract void UngrabWindow(IntPtr hwnd);
 368
 369                 internal abstract void SendAsyncMethod (AsyncMethodData method);
 370                 internal abstract void SetTimer (Timer timer);
 371                 internal abstract void KillTimer (Timer timer);
 372
 373                 internal abstract void CreateCaret(IntPtr hwnd, int width, int height);
 374                 internal abstract void DestroyCaret(IntPtr hwnd);
 375                 internal abstract void SetCaretPos(IntPtr hwnd, int x, int y);
 376                 internal abstract void CaretVisible(IntPtr hwnd, bool visible);
 377
 378                 internal abstract IntPtr GetFocus();
 379                 internal abstract void SetFocus(IntPtr hwnd);
 380                 internal abstract IntPtr GetActive();
 381                 internal abstract IntPtr GetPreviousWindow(IntPtr hwnd);
 382
 383                 internal abstract void ScrollWindow(IntPtr hwnd, Rectangle rectangle, int XAmount, int YAmount, bool with_children);
 384                 internal abstract void ScrollWindow(IntPtr hwnd, int XAmount, int YAmount, bool with_children);
 385
 386                 internal abstract bool GetFontMetrics(Graphics g, Font font, out int ascent, out int descent);
 387
 388                 internal abstract bool SystrayAdd(IntPtr hwnd, string tip, Icon icon, out ToolTip tt);
 389                 internal abstract bool SystrayChange(IntPtr hwnd, string tip, Icon icon, ref ToolTip tt);
 390                 internal abstract void SystrayRemove(IntPtr hwnd, ref ToolTip tt);
 391                 internal abstract void SystrayBalloon(IntPtr hwnd, int timeout, string title, string text, ToolTipIcon icon);
 392
 393                 internal abstract Point GetMenuOrigin(IntPtr hwnd);
 394                 internal abstract void MenuToScreen(IntPtr hwnd, ref int x, ref int y);
 395                 internal abstract void ScreenToMenu(IntPtr hwnd, ref int x, ref int y);
 396
 397                 internal abstract void SetIcon(IntPtr handle, Icon icon);
 398
 399                 internal abstract void ClipboardClose(IntPtr handle);
 400                 internal abstract IntPtr ClipboardOpen (bool primary_selection);
 401                 internal abstract int ClipboardGetID(IntPtr handle, string format);
 402                 internal abstract void ClipboardStore(IntPtr handle, object obj, int id, XplatUI.ObjectToClipboard converter, bool copy);
 403                 internal abstract int[] ClipboardAvailableFormats(IntPtr handle);
 404                 internal abstract object ClipboardRetrieve(IntPtr handle, int id, XplatUI.ClipboardToObject converter);
 405
 406                 internal abstract void DrawReversibleLine(Point start, Point end, Color backColor);
 407                 internal abstract void DrawReversibleRectangle(IntPtr handle, Rectangle rect, int line_width);
 408                 internal abstract void FillReversibleRectangle (Rectangle rectangle, Color backColor);
 409                 internal abstract void DrawReversibleFrame (Rectangle rectangle, Color backColor, FrameStyle style);
 410
 411                 internal abstract SizeF GetAutoScaleSize(Font font);
 412
 413                 internal abstract IntPtr SendMessage(IntPtr hwnd, Msg message, IntPtr wParam, IntPtr lParam);
 414                 internal abstract bool PostMessage(IntPtr hwnd, Msg message, IntPtr wParam, IntPtr lParam);
 415                 internal abstract int SendInput(IntPtr hwnd, System.Collections.Queue keys);
 416
 417                 internal abstract object StartLoop(Thread thread);
 418                 internal abstract void EndLoop(Thread thread);
 419
 420                 internal abstract void RequestNCRecalc(IntPtr hwnd);
 421                 internal abstract void ResetMouseHover(IntPtr hwnd);
 422                 internal abstract void RequestAdditionalWM_NCMessages(IntPtr hwnd, bool hover, bool leave);
 423
 424                 internal abstract void RaiseIdle (EventArgs e);
 425
 426                 // System information
 427                 internal abstract int KeyboardSpeed { get; }
 428                 internal abstract int KeyboardDelay { get; }
 429
 430
 431                 // Double buffering
 432                 internal virtual void CreateOffscreenDrawable (IntPtr handle,
 433                                                                int width, int height,
 434                                                                out object offscreen_drawable)
 435                 {
 436                         Bitmap bmp = new Bitmap (width, height, System.Drawing.Imaging.PixelFormat.Format32bppArgb);
 437
 438                         offscreen_drawable = bmp;
 439                 }
 440
 441                 internal virtual void DestroyOffscreenDrawable (object offscreen_drawable)
 442                 {
 443                         Bitmap bmp = (Bitmap)offscreen_drawable;
 444
 445                         bmp.Dispose ();
 446                 }
 447
 448                 internal virtual Graphics GetOffscreenGraphics (object offscreen_drawable)
 449                 {
 450                         Bitmap bmp = (Bitmap)offscreen_drawable;
 451                         return Graphics.FromImage (bmp);
 452                 }
 453
 454                 internal virtual void BlitFromOffscreen (IntPtr dest_handle,
 455                                                          Graphics dest_dc,
 456                                                          object offscreen_drawable,
 457                                                          Graphics offscreen_dc,
 458                                                          Rectangle r)
 459                 {
 460                         dest_dc.DrawImage ((Bitmap)offscreen_drawable, r, r, GraphicsUnit.Pixel);
 461                 }
 462
 463                 internal virtual void SetForegroundWindow (IntPtr handle)
 464                 {
 465                 }
 466
 467 #endregion      // XplatUI Driver Methods
 468         }
 469
 470         internal class XplatUIDriverSupport {
 471                 #region XplatUI Driver Support Methods
 472                 internal static void ExecutionCallback (object state)
 473                 {
 474                         AsyncMethodData data = (AsyncMethodData) state;
 475                         AsyncMethodResult result = data.Result;
 476
 477                         object ret;
 478                         try {
 479                                 ret = data.Method.DynamicInvoke (data.Args);
 480                         } catch (Exception ex) {
 481                                 if (result != null) {
 482                                         result.CompleteWithException (ex);
 483                                         return;
 484                                 }
 485
 486                                 throw;
 487                         }
 488
 489                         if (result != null) {
 490                                 result.Complete (ret);
 491                         }
 492                 }
 493
 494                 internal static void ExecuteClientMessage (GCHandle gchandle)
 495                 {
 496                         AsyncMethodData data = (AsyncMethodData) gchandle.Target;
 497                         try {
 498                                 if (data.Context == null) {
 499                                         ExecutionCallback (data);
 500                                 } else {
 501                                         ExecutionContext.Run (data.Context, new ContextCallback (ExecutionCallback), data);
 502                                 }
 503                         }
 504                         finally {
 505                                 gchandle.Free ();
 506                         }
 507                 }
 508
 509                 #endregion      // XplatUI Driver Support Methods
 510         }
 511 }