src/motif/frame.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/motif/frame.cpp
   3 // Purpose:     wxFrame
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __VMS
  24 #define XtDisplay XTDISPLAY
  25 #define XtWindow XTWINDOW
  26 #define XtScreen XTSCREEN
  27 #endif
  28
  29 #include "wx/frame.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/log.h"
  33     #include "wx/app.h"
  34     #include "wx/utils.h"
  35     #include "wx/menu.h"
  36     #include "wx/icon.h"
  37     #include "wx/settings.h"
  38     #include "wx/toolbar.h"
  39     #include "wx/statusbr.h"
  40 #endif
  41
  42 #ifdef __VMS__
  43     #pragma message disable nosimpint
  44 #endif
  45
  46 #if defined(__ultrix) || defined(__sgi)
  47     #include <Xm/Frame.h>
  48 #endif
  49
  50 #include <Xm/Xm.h>
  51 #include <X11/Shell.h>
  52 #include <X11/Core.h>
  53 #if XmVersion >= 1002
  54     #include <Xm/XmAll.h>
  55 #else
  56     #include <Xm/Frame.h>
  57 #endif
  58 #include <Xm/MwmUtil.h>
  59 #include <Xm/BulletinB.h>
  60 #include <Xm/Form.h>
  61 #include <Xm/MainW.h>
  62 #include <Xm/RowColumn.h>
  63 #include <Xm/Label.h>
  64 #include <Xm/AtomMgr.h>
  65 #include <Xm/LabelG.h>
  66 #include <Xm/Frame.h>
  67 #if   XmVersion > 1000
  68     #include <Xm/Protocols.h>
  69 #endif
  70
  71 #ifdef __VMS__
  72     #pragma message enable nosimpint
  73 #endif
  74
  75 #include "wx/motif/private.h"
  76 #include "wx/unix/utilsx11.h"
  77
  78 // ----------------------------------------------------------------------------
  79 // private functions
  80 // ----------------------------------------------------------------------------
  81
  82 static void wxFrameMapProc(Widget frameShell, XtPointer clientData,
  83                            XCrossingEvent* event);
  84
  85 // ----------------------------------------------------------------------------
  86 // globals
  87 // ----------------------------------------------------------------------------
  88
  89 extern wxList wxModelessWindows;
  90
  91 // ----------------------------------------------------------------------------
  92 // wxWin macros
  93 // ----------------------------------------------------------------------------
  94
  95 BEGIN_EVENT_TABLE(wxFrame, wxFrameBase)
  96     EVT_ACTIVATE(wxFrame::OnActivate)
  97     EVT_SYS_COLOUR_CHANGED(wxFrame::OnSysColourChanged)
  98 END_EVENT_TABLE()
  99
 100 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxTopLevelWindow)
 101
 102 // ============================================================================
 103 // implementation
 104 // ============================================================================
 105
 106 // ----------------------------------------------------------------------------
 107 // frame construction
 108 // ----------------------------------------------------------------------------
 109
 110 void wxFrame::Init()
 111 {
 112     m_iconized = false;
 113
 114     //// Motif-specific
 115     m_frameShell = (WXWidget) NULL;
 116     m_mainWidget = (WXWidget) NULL;
 117     m_workArea = (WXWidget) NULL;
 118     m_clientArea = (WXWidget) NULL;
 119 }
 120
 121 bool wxFrame::Create(wxWindow *parent,
 122                      wxWindowID id,
 123                      const wxString& title,
 124                      const wxPoint& pos,
 125                      const wxSize& size,
 126                      long style,
 127                      const wxString& name)
 128 {
 129     if( !wxTopLevelWindow::Create( parent, id, title, pos, size, style,
 130                                    name ) )
 131         return false;
 132
 133     m_backgroundColour =
 134         wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE);
 135     m_foregroundColour = *wxBLACK;
 136     m_font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 137
 138     int x = pos.x, y = pos.y;
 139     int width = size.x, height = size.y;
 140
 141     // Set reasonable values for position and size if defaults have been
 142     // requested
 143     //
 144     // MB TODO: something better than these arbitrary values ?
 145     // VZ       should use X resources for this...
 146     if ( width == -1 )
 147         width = 400;
 148     if ( height == -1 )
 149         height = 400;
 150
 151     int displayW, displayH;
 152     wxDisplaySize( &displayW, &displayH );
 153
 154     if ( x == -1 )
 155     {
 156         x = (displayW - width) / 2;
 157         if (x < 10) x = 10;
 158     }
 159     if ( y == -1 )
 160     {
 161         y = (displayH - height) / 2;
 162         if (y < 10) y = 10;
 163     }
 164
 165     SetTitle( title );
 166
 167     wxLogTrace(wxTRACE_Messages,
 168                "Created frame (0x%p) with work area 0x%p and client "
 169                "area 0x%p", m_mainWidget, m_workArea, m_clientArea);
 170
 171     XtAddEventHandler((Widget) m_clientArea, ExposureMask,False,
 172         wxUniversalRepaintProc, (XtPointer) this);
 173
 174     if (x > -1)
 175         XtVaSetValues((Widget) m_frameShell, XmNx, x, NULL);
 176     if (y > -1)
 177         XtVaSetValues((Widget) m_frameShell, XmNy, y, NULL);
 178     if (width > -1)
 179         XtVaSetValues((Widget) m_frameShell, XmNwidth, width, NULL);
 180     if (height > -1)
 181         XtVaSetValues((Widget) m_frameShell, XmNheight, height, NULL);
 182
 183     ChangeFont(false);
 184
 185     ChangeBackgroundColour();
 186
 187     PreResize();
 188
 189     wxSize newSize(width, height);
 190     wxSizeEvent sizeEvent(newSize, GetId());
 191     sizeEvent.SetEventObject(this);
 192
 193     GetEventHandler()->ProcessEvent(sizeEvent);
 194
 195     return true;
 196 }
 197
 198 bool wxFrame::XmDoCreateTLW(wxWindow* WXUNUSED(parent),
 199                             wxWindowID WXUNUSED(id),
 200                             const wxString& WXUNUSED(title),
 201                             const wxPoint& WXUNUSED(pos),
 202                             const wxSize& WXUNUSED(size),
 203                             long style,
 204                             const wxString& name)
 205 {
 206     Widget frameShell;
 207
 208     frameShell = XtCreatePopupShell( name, topLevelShellWidgetClass,
 209                                      (Widget)wxTheApp->GetTopLevelWidget(),
 210                                      NULL, 0 );
 211
 212     XtVaSetValues(frameShell,
 213         // Allows menu to resize
 214         XmNallowShellResize, True,
 215         XmNdeleteResponse, XmDO_NOTHING,
 216         XmNmappedWhenManaged, False,
 217         XmNiconic, (style & wxICONIZE) ? True : False,
 218         NULL);
 219
 220     m_frameShell = (WXWidget)frameShell;
 221
 222     m_mainWidget = (WXWidget) XtVaCreateManagedWidget("main_window",
 223         xmMainWindowWidgetClass, frameShell,
 224         XmNresizePolicy, XmRESIZE_NONE,
 225         NULL);
 226
 227     m_workArea = (WXWidget) XtVaCreateWidget("form",
 228         xmFormWidgetClass, (Widget) m_mainWidget,
 229         XmNresizePolicy, XmRESIZE_NONE,
 230         NULL);
 231
 232     m_clientArea = (WXWidget) XtVaCreateWidget("client",
 233         xmBulletinBoardWidgetClass, (Widget) m_workArea,
 234         XmNmarginWidth, 0,
 235         XmNmarginHeight, 0,
 236         XmNrightAttachment, XmATTACH_FORM,
 237         XmNleftAttachment, XmATTACH_FORM,
 238         XmNtopAttachment, XmATTACH_FORM,
 239         XmNbottomAttachment, XmATTACH_FORM,
 240         NULL);
 241
 242     XtVaSetValues((Widget) m_mainWidget,
 243         XmNworkWindow, (Widget) m_workArea,
 244         NULL);
 245
 246     XtManageChild((Widget) m_clientArea);
 247     XtManageChild((Widget) m_workArea);
 248
 249     XtTranslations ptr = XtParseTranslationTable( "<Configure>: resize()" );
 250     XtOverrideTranslations( (Widget) m_workArea, ptr );
 251     XtFree( (char *)ptr );
 252
 253     /* Part of show-&-hide fix */
 254     XtAddEventHandler( frameShell, StructureNotifyMask,
 255                        False, (XtEventHandler)wxFrameMapProc,
 256                        (XtPointer)this );
 257
 258     XtRealizeWidget(frameShell);
 259
 260     wxAddWindowToTable( (Widget)m_workArea, this);
 261     wxAddWindowToTable( (Widget)m_clientArea, this);
 262
 263     wxModelessWindows.Append( this );
 264
 265     return true;
 266 }
 267
 268 wxFrame::~wxFrame()
 269 {
 270     m_isBeingDeleted = true;
 271
 272     if (m_clientArea)
 273     {
 274       XtRemoveEventHandler((Widget) m_clientArea, ExposureMask, False,
 275           wxUniversalRepaintProc, (XtPointer) this);
 276     }
 277
 278     if (GetMainWidget())
 279         Show(false);
 280
 281     if (m_frameMenuBar)
 282     {
 283         m_frameMenuBar->DestroyMenuBar();
 284         delete m_frameMenuBar;
 285         m_frameMenuBar = NULL;
 286     }
 287
 288     if (m_frameStatusBar)
 289     {
 290         delete m_frameStatusBar;
 291         m_frameStatusBar = NULL;
 292     }
 293
 294     PreDestroy();
 295
 296     Widget frameShell = (Widget)GetShellWidget();
 297
 298     if( frameShell )
 299         XtRemoveEventHandler( frameShell, StructureNotifyMask,
 300                               False, (XtEventHandler)wxFrameMapProc,
 301                               (XtPointer)this );
 302
 303     if( m_clientArea )
 304     {
 305         wxDeleteWindowFromTable( (Widget)m_clientArea );
 306         XtDestroyWidget( (Widget)m_clientArea );
 307     }
 308
 309     if( m_workArea )
 310     {
 311         XtVaSetValues( (Widget)m_mainWidget,
 312                        XmNworkWindow, (Widget)NULL,
 313                        NULL );
 314
 315         wxDeleteWindowFromTable( (Widget)m_workArea );
 316         XtDestroyWidget( (Widget)m_workArea );
 317     }
 318
 319     if( m_mainWidget )
 320         XtDestroyWidget( (Widget)m_mainWidget );
 321
 322     if( frameShell )
 323         XtDestroyWidget( frameShell );
 324 }
 325
 326 // Get size *available for subwindows* i.e. excluding menu bar, toolbar etc.
 327 void wxFrame::DoGetClientSize(int *x, int *y) const
 328 {
 329     Dimension xx, yy;
 330     XtVaGetValues((Widget) m_workArea, XmNwidth, &xx, XmNheight, &yy, NULL);
 331
 332     if (m_frameStatusBar)
 333     {
 334         int sbw, sbh;
 335         m_frameStatusBar->GetSize(& sbw, & sbh);
 336         yy = (Dimension)(yy - sbh);
 337     }
 338 #if wxUSE_TOOLBAR
 339     if (m_frameToolBar)
 340     {
 341         int tbw, tbh;
 342         m_frameToolBar->GetSize(& tbw, & tbh);
 343         if (m_frameToolBar->GetWindowStyleFlag() & wxTB_VERTICAL)
 344             xx = (Dimension)(xx - tbw);
 345         else
 346             yy = (Dimension)(yy - tbh);
 347     }
 348 #endif // wxUSE_TOOLBAR
 349
 350 //CE found a call here with NULL y pointer
 351     if (x)
 352         *x = xx;
 353     if (y)
 354         *y = yy;
 355 }
 356
 357 // Set the client size (i.e. leave the calculation of borders etc.
 358 // to wxWidgets)
 359 void wxFrame::DoSetClientSize(int width, int height)
 360 {
 361     // Calculate how large the new main window should be
 362     // by finding the difference between the client area and the
 363     // main window area, and adding on to the new client area
 364     if (width > -1)
 365         XtVaSetValues((Widget) m_workArea, XmNwidth, width, NULL);
 366
 367     if (height > -1)
 368     {
 369         if (m_frameStatusBar)
 370         {
 371             int sbw, sbh;
 372             m_frameStatusBar->GetSize(& sbw, & sbh);
 373             height += sbh;
 374         }
 375 #if wxUSE_TOOLBAR
 376         if (m_frameToolBar)
 377         {
 378             int tbw, tbh;
 379             m_frameToolBar->GetSize(& tbw, & tbh);
 380             if (m_frameToolBar->GetWindowStyleFlag() & wxTB_VERTICAL)
 381                 width += tbw;
 382             else
 383                 height += tbh;
 384         }
 385 #endif // wxUSE_TOOLBAR
 386
 387         XtVaSetValues((Widget) m_workArea, XmNheight, height, NULL);
 388     }
 389     PreResize();
 390
 391     wxSize newSize(width, height);
 392     wxSizeEvent sizeEvent(newSize, GetId());
 393     sizeEvent.SetEventObject(this);
 394
 395     GetEventHandler()->ProcessEvent(sizeEvent);
 396
 397 }
 398
 399 void wxFrame::DoGetSize(int *width, int *height) const
 400 {
 401     Dimension xx, yy;
 402     XtVaGetValues((Widget) m_frameShell, XmNwidth, &xx, XmNheight, &yy, NULL);
 403     *width = xx; *height = yy;
 404 }
 405
 406 void wxFrame::DoSetSize(int x, int y, int width, int height, int WXUNUSED(sizeFlags))
 407 {
 408     if (x > -1)
 409         XtVaSetValues((Widget) m_frameShell, XmNx, x, NULL);
 410     if (y > -1)
 411         XtVaSetValues((Widget) m_frameShell, XmNy, y, NULL);
 412     if (width > -1)
 413         XtVaSetValues((Widget) m_mainWidget, XmNwidth, width, NULL);
 414     if (height > -1)
 415         XtVaSetValues((Widget) m_mainWidget, XmNheight, height, NULL);
 416
 417     if (!(height == -1 && width == -1))
 418     {
 419         PreResize();
 420     }
 421 }
 422
 423 bool wxFrame::Show( bool show )
 424 {
 425     if( !wxWindowBase::Show( show ) )
 426         return false;
 427
 428     m_isShown = show;
 429
 430     Widget shell = (Widget)GetShellWidget();
 431     if (!shell)
 432         return wxWindow::Show(show);
 433
 434     SetVisibleStatus(show);
 435     if (show)
 436     {
 437         XtPopup(shell, XtGrabNone);
 438     }
 439     else
 440     {
 441         XtPopdown(shell);
 442     }
 443
 444     return true;
 445 }
 446
 447 void wxFrame::SetTitle(const wxString& title)
 448 {
 449     wxString oldTitle = GetTitle();
 450     if( title == oldTitle )
 451         return;
 452
 453     wxTopLevelWindow::SetTitle( title );
 454
 455     if( !title.empty() )
 456         XtVaSetValues( (Widget)m_frameShell,
 457                        XmNtitle, title.c_str(),
 458                        XmNiconName, title.c_str(),
 459                        NULL );
 460 }
 461
 462 void wxFrame::DoSetIcon(const wxIcon& icon)
 463 {
 464     if (!m_frameShell)
 465         return;
 466
 467     if (!icon.Ok() || !icon.GetDrawable())
 468         return;
 469
 470     XtVaSetValues((Widget) m_frameShell,
 471                   XtNiconPixmap, icon.GetDrawable(),
 472                   NULL);
 473 }
 474
 475 void wxFrame::SetIcon(const wxIcon& icon)
 476 {
 477     SetIcons( wxIconBundle( icon ) );
 478 }
 479
 480 void wxFrame::SetIcons(const wxIconBundle& icons)
 481 {
 482     wxFrameBase::SetIcons( icons );
 483
 484     if (!m_frameShell)
 485         return;
 486
 487     DoSetIcon( m_icons.GetIcon( -1 ) );
 488     wxSetIconsX11(GetXDisplay(),
 489                   (WXWindow) XtWindow( (Widget) m_frameShell ), icons);
 490 }
 491
 492 void wxFrame::PositionStatusBar()
 493 {
 494     if (!m_frameStatusBar)
 495         return;
 496
 497     int w, h;
 498     GetClientSize(&w, &h);
 499     int sw, sh;
 500     m_frameStatusBar->GetSize(&sw, &sh);
 501
 502     // Since we wish the status bar to be directly under the client area,
 503     // we use the adjusted sizes without using wxSIZE_NO_ADJUSTMENTS.
 504     m_frameStatusBar->SetSize(0, h, w, sh);
 505 }
 506
 507 WXWidget wxFrame::GetMenuBarWidget() const
 508 {
 509     if (GetMenuBar())
 510         return GetMenuBar()->GetMainWidget();
 511     else
 512         return (WXWidget) NULL;
 513 }
 514
 515 void wxFrame::SetMenuBar(wxMenuBar *menuBar)
 516 {
 517     if (!menuBar)
 518     {
 519         m_frameMenuBar = NULL;
 520         return;
 521     }
 522
 523     // Currently can't set it twice
 524     //    wxASSERT_MSG( (m_frameMenuBar == (wxMenuBar*) NULL), "Cannot set the menubar more than once");
 525
 526     if (m_frameMenuBar)
 527     {
 528         m_frameMenuBar->DestroyMenuBar();
 529         delete m_frameMenuBar;
 530     }
 531
 532     m_frameMenuBar = menuBar;
 533     m_frameMenuBar->CreateMenuBar(this);
 534 }
 535
 536 // Responds to colour changes, and passes event on to children.
 537 void wxFrame::OnSysColourChanged(wxSysColourChangedEvent& event)
 538 {
 539     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE));
 540     Refresh();
 541
 542     if ( m_frameStatusBar )
 543     {
 544         wxSysColourChangedEvent event2;
 545         event2.SetEventObject( m_frameStatusBar );
 546         m_frameStatusBar->ProcessEvent(event2);
 547     }
 548
 549     // Propagate the event to the non-top-level children
 550     wxWindow::OnSysColourChanged(event);
 551 }
 552
 553 // Default activation behaviour - set the focus for the first child
 554 // subwindow found.
 555 void wxFrame::OnActivate(wxActivateEvent& event)
 556 {
 557     if (!event.GetActive())
 558         return;
 559
 560     for(wxWindowList::compatibility_iterator node = GetChildren().GetFirst(); node;
 561         node = node->GetNext())
 562     {
 563         // Find a child that's a subwindow, but not a dialog box.
 564         wxWindow *child = node->GetData();
 565         if (!child->IsTopLevel())
 566         {
 567             child->SetFocus();
 568             return;
 569         }
 570     }
 571 }
 572
 573 void wxFrame::SendSizeEvent()
 574 {
 575     wxSizeEvent event(GetSize(), GetId());
 576     event.SetEventObject(this);
 577     GetEventHandler()->AddPendingEvent(event);
 578 }
 579
 580 #if wxUSE_TOOLBAR
 581
 582 wxToolBar* wxFrame::CreateToolBar(long style,
 583                                   wxWindowID id,
 584                                   const wxString& name)
 585 {
 586     if ( wxFrameBase::CreateToolBar(style, id, name) )
 587     {
 588         PositionToolBar();
 589     }
 590
 591     return m_frameToolBar;
 592 }
 593
 594 void wxFrame::SetToolBar(wxToolBar *toolbar)
 595 {
 596     wxFrameBase::SetToolBar(toolbar);
 597     SendSizeEvent();
 598 }
 599
 600 void wxFrame::PositionToolBar()
 601 {
 602     wxToolBar* tb = GetToolBar();
 603     if (tb)
 604     {
 605         int cw, ch;
 606         GetClientSize(& cw, &ch);
 607
 608         int tw, th;
 609         tb->GetSize(& tw, & th);
 610
 611         if (tb->GetWindowStyleFlag() & wxTB_VERTICAL)
 612         {
 613             // Use the 'real' position. wxSIZE_NO_ADJUSTMENTS
 614             // means, pretend we don't have toolbar/status bar, so we
 615             // have the original client size.
 616             th = ch + th;
 617         }
 618         else
 619         {
 620             // Use the 'real' position
 621             tw = cw;
 622         }
 623
 624         tb->SetSize(0, 0, -1, -1, wxSIZE_NO_ADJUSTMENTS);
 625     }
 626 }
 627 #endif // wxUSE_TOOLBAR
 628
 629 //// Motif-specific
 630 bool wxFrame::PreResize()
 631 {
 632 #if wxUSE_TOOLBAR
 633     PositionToolBar();
 634 #endif // wxUSE_TOOLBAR
 635
 636 #if wxUSE_STATUSBAR
 637     PositionStatusBar();
 638 #endif // wxUSE_STATUSBAR
 639
 640     return true;
 641 }
 642
 643 WXWidget wxFrame::GetClientWidget() const
 644 {
 645     return m_clientArea;
 646 }
 647
 648 void wxFrame::ChangeFont(bool WXUNUSED(keepOriginalSize))
 649 {
 650     // TODO
 651 }
 652
 653 void wxFrame::ChangeBackgroundColour()
 654 {
 655     if (GetClientWidget())
 656         wxDoChangeBackgroundColour(GetClientWidget(), m_backgroundColour);
 657 }
 658
 659 void wxFrame::ChangeForegroundColour()
 660 {
 661     if (GetClientWidget())
 662         wxDoChangeForegroundColour(GetClientWidget(), m_foregroundColour);
 663 }
 664
 665 /* MATTEW: Used to insure that hide-&-show within an event cycle works */
 666 static void wxFrameMapProc( Widget frameShell, XtPointer clientData,
 667                             XCrossingEvent* event )
 668 {
 669     wxFrame *tli = (wxFrame*)clientData;
 670
 671     XEvent *e = (XEvent *)event;
 672
 673     if( e->xany.type == MapNotify )
 674     {
 675         // Iconize fix
 676         XtVaSetValues( frameShell, XmNiconic, (Boolean)False, NULL );
 677         if( !tli->GetVisibleStatus() )
 678         {
 679             /* We really wanted this to be hidden! */
 680             XtUnmapWidget( frameShell );
 681         }
 682     }
 683     else if( e->xany.type == UnmapNotify )
 684         // Iconize fix
 685         XtVaSetValues( frameShell, XmNiconic, (Boolean)True, NULL );
 686 }