TGWindow.cxx

Go to the documentation of this file.

// @(#)root/gui:$Id$
// Author: Fons Rademakers   28/12/97
 
/*************************************************************************
 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
/**************************************************************************
 
    This source is based on Xclass95, a Win95-looking GUI toolkit.
    Copyright (C) 1996, 1997 David Barth, Ricky Ralston, Hector Peraza.
 
    Xclass95 is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
**************************************************************************/
 
 
/** \class TGWindow
    \ingroup guiwidgets
 
ROOT GUI Window base class.
 
*/
 
 
#include "TGWindow.h"
#include <iostream>
#include "TVirtualX.h"
#include "TApplication.h"
#include "TError.h"
#include "TSystem.h"
 
 
Int_t TGWindow::fgCounter = 0;
 
////////////////////////////////////////////////////////////////////////////////
/// Create a new window. Parent p must exist otherwise the root window
/// is taken as parent. No arguments specified results in values from
/// parent to be taken (or defaults).
 
TGWindow::TGWindow(const TGWindow *p, Int_t x, Int_t y, UInt_t w, UInt_t h,
                   UInt_t border, Int_t depth, UInt_t clss, void *visual,
                   SetWindowAttributes_t *attr, UInt_t wtype)
{
   UInt_t type = wtype;
   fId = 0;
   fParent = 0;
   fNeedRedraw = kFALSE;
 
   if (!p && !gClient && !gApplication) {
      ::Error("TGWindow::TGWindow",
              "gClient and gApplication are nullptr!\n"
              "Please add a TApplication instance in the main() function of your application\n");
      gSystem->Exit(1);
   }
 
   if (!p && gClient) {
      p = gClient->GetRoot();
   }
 
   if (p) {
      fClient = p->fClient;
      if (fClient->IsEditable()) type = wtype & ~1;
 
      fParent = p;
      if (fParent && fParent->IsMapSubwindows()) {
         fId = gVirtualX->CreateWindow(fParent->fId, x, y,
                                     std::max(w, (UInt_t) 1),
                                     std::max(h, (UInt_t) 1), border,
                                     depth, clss, visual, attr, type);
         fClient->RegisterWindow(this);
      }
 
      // name will be used in SavePrimitive methods
      fgCounter++;
      fName = "frame";
      fName += fgCounter;
   }
   fEditDisabled = (fId != gVirtualX->GetDefaultRootWindow()) && fParent ?
                    (fParent->fEditDisabled == kEditDisable) : 0;
 
   // add protection for the root window on Cocoa (MacOS X)
   if (fClient && fClient->GetDefaultRoot())
      SetWindowName();
}
 
////////////////////////////////////////////////////////////////////////////////
/// Create a copy of a window.
 
TGWindow::TGWindow(TGClient *c, Window_t id, const TGWindow *parent)
{
   fClient = c;
   fId     = id;
   fParent = parent;
   fClient->RegisterWindow(this);
   fNeedRedraw = kFALSE;
   fEditDisabled = (fId != gVirtualX->GetDefaultRootWindow()) && fParent ?
                    fParent->fEditDisabled : kFALSE;
 
   // name used in SavePrimitive methods
   fgCounter++;
   fName = "frame";
   fName += fgCounter;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Window destructor. Unregisters the window.
 
TGWindow::~TGWindow()
{
   if (fClient) {
      if (fParent == fClient->GetDefaultRoot())
         DestroyWindow();
      fClient->UnregisterWindow(this);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Set window name.
 
void TGWindow::SetWindowName(const char *name)
{
#ifdef R__MACOSX
   // MacOS fails to find the drawable of GetDefaultRootWindow(), only subsequent
   // windows ids can be found. See discussion here:
   // https://github.com/root-project/root/pull/6757#discussion_r518776154
   if (fId == gVirtualX->GetDefaultRootWindow())
      return;
#endif
 
   if (!name && gDebug > 0) {
      // set default frame names only when in debug mode
      TString wname = ClassName();
      wname += "::" + fName;
      gVirtualX->SetWindowName(fId, (char *)wname.Data());
   } else {
      gVirtualX->SetWindowName(fId, (char *)name);
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns top level main frame.
 
const TGWindow *TGWindow::GetMainFrame() const
{
   return ((fParent == 0) || (fParent == fClient->GetDefaultRoot())) ? this : fParent->GetMainFrame();
}
 
////////////////////////////////////////////////////////////////////////////////
/// map window
 
void TGWindow::MapWindow()
{
   gVirtualX->MapWindow(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// map sub windows
 
void TGWindow::MapSubwindows()
{
   gVirtualX->MapSubwindows(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// map raised
 
void TGWindow::MapRaised()
{
   gVirtualX->MapRaised(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// unmap window
 
void TGWindow::UnmapWindow()
{
   gVirtualX->UnmapWindow(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// destroy window
 
void TGWindow::DestroyWindow()
{
   gVirtualX->DestroyWindow(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// destroy sub windows
 
void TGWindow::DestroySubwindows()
{
   gVirtualX->DestroySubwindows(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// raise window
 
void TGWindow::RaiseWindow()
{
   gVirtualX->RaiseWindow(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// lower window
 
void TGWindow::LowerWindow()
{
   gVirtualX->LowerWindow(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// iconify window
 
void TGWindow::IconifyWindow()
{
   gVirtualX->IconifyWindow(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// request focus
 
void TGWindow::RequestFocus()
{
   gVirtualX->SetInputFocus(fId);
}
 
////////////////////////////////////////////////////////////////////////////////
/// set background color
 
void TGWindow::SetBackgroundColor(Pixel_t color)
{
   gVirtualX->SetWindowBackground(fId, color);
}
 
////////////////////////////////////////////////////////////////////////////////
/// set background pixmap
 
void TGWindow::SetBackgroundPixmap(Pixmap_t pixmap)
{
   gVirtualX->SetWindowBackgroundPixmap(fId, pixmap);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Reparent window, make p the new parent and position the window at
/// position (x,y) in new parent.
 
void TGWindow::ReparentWindow(const TGWindow *p, Int_t x, Int_t y)
{
   if (p == fParent) return;
 
   if (p) {
      gVirtualX->ReparentWindow(fId, p->GetId(), x, y);
      gVirtualX->Update(1);
   }
   fParent = p;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Move the window.
 
void TGWindow::Move(Int_t x, Int_t y)
{
   gVirtualX->MoveWindow(fId, x, y);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Resize the window.
 
void TGWindow::Resize(UInt_t w, UInt_t h)
{
   gVirtualX->ResizeWindow(fId, std::max(w, (UInt_t)1), std::max(h, (UInt_t)1));
}
 
////////////////////////////////////////////////////////////////////////////////
/// Move and resize the window.
 
void TGWindow::MoveResize(Int_t x, Int_t y, UInt_t w, UInt_t h)
{
   gVirtualX->MoveResizeWindow(fId, x, y, std::max(w, (UInt_t)1), std::max(h, (UInt_t)1));
}
 
////////////////////////////////////////////////////////////////////////////////
/// Returns kTRUE if window is mapped on screen, kFALSE otherwise.
 
Bool_t TGWindow::IsMapped()
{
   WindowAttributes_t attr;
 
   gVirtualX->GetWindowAttributes(fId, attr);
   return (attr.fMapState != kIsUnmapped);
}
 
////////////////////////////////////////////////////////////////////////////////
/// Print window id.
/// If option is "tree" - print all parent windows tree
 
void TGWindow::Print(Option_t *option) const
{
   TString opt = option;
 
   if (opt.Contains("tree")) {
 
      const TGWindow *parent = fParent;
      std::cout << ClassName() << ":\t" << fId << std::endl;
 
      while (parent && (parent != fClient->GetDefaultRoot())) {
         std::cout << "\t" << parent->ClassName() << ":\t" << parent->GetId() << std::endl;
         parent = parent->GetParent();
      }
   } else {
      std::cout << ClassName() << ":\t" << fId << std::endl;
   }
}
 
////////////////////////////////////////////////////////////////////////////////
/// Return global window counter (total number of created windows).
 
Int_t TGWindow::GetCounter()
{
   return fgCounter;
}
 
////////////////////////////////////////////////////////////////////////////////
/// Return unique name, used in SavePrimitive methods.
 
const char *TGWindow::GetName()const
{
   TGWindow *w = (TGWindow*)this;
 
   if (fName.BeginsWith("frame")) {
      TString cname = ClassName();
      if (cname.BeginsWith("TGed"))
         cname.Replace(0, 1, 'f');
      else if (cname.BeginsWith("TG"))
         cname.Replace(0,2,'f');
      else
         cname.Replace(0, 1, 'f');
      w->fName.Remove(0,5);
      w->fName = cname + w->fName;
   }
 
   if (w->fName.Contains(" "))
      w->fName.ReplaceAll(" ", "");
   if (w->fName.Contains(":"))
      w->fName.ReplaceAll(":", "");
 
   return fName.Data();
}