TRootHelpDialog.cxx

Go to the documentation of this file.

// @(#)root/gui:$Id$
// Author: Fons Rademakers   24/02/98

/*************************************************************************
 * 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.             *
 *************************************************************************/

//////////////////////////////////////////////////////////////////////////
//                                                                      //
// TRootHelpDialog                                                      //
//                                                                      //
// A TRootHelpDialog is used to display help text (or any text in a     //
// dialog window). There is on OK button to popdown the dialog.         //
//                                                                      //
//////////////////////////////////////////////////////////////////////////

#include "TRootHelpDialog.h"
#include "TGButton.h"
#include "TGTextView.h"


ClassImp(TRootHelpDialog);

////////////////////////////////////////////////////////////////////////////////
/// Create a help text dialog.

TRootHelpDialog::TRootHelpDialog(const TGWindow *main,
    const char *title, UInt_t w, UInt_t h) :
    TGTransientFrame(gClient->GetRoot(), main, w, h)
{
   fView = new TGTextView(this, w, h, kSunkenFrame | kDoubleBorder);
   fL1 = new TGLayoutHints(kLHintsExpandX | kLHintsExpandY, 3, 3, 3, 3);
   AddFrame(fView, fL1);

   fOK = new TGTextButton(this, "  &OK  ");
   fL2 = new TGLayoutHints(kLHintsBottom | kLHintsCenterX, 0, 0, 5, 5);
   AddFrame(fOK, fL2);

   SetWindowName(title);
   SetIconName(title);

   MapSubwindows();

   Resize(GetDefaultSize());

   // position relative to the parent's window
   CenterOnParent();
}

////////////////////////////////////////////////////////////////////////////////
/// Delete help text dialog.

TRootHelpDialog::~TRootHelpDialog()
{
   delete fView;
   delete fOK;
   delete fL1;
   delete fL2;
}

////////////////////////////////////////////////////////////////////////////////
/// Show help dialog.

void TRootHelpDialog::Popup()
{
   MapWindow();
}

////////////////////////////////////////////////////////////////////////////////
/// Set help text from helpText buffer in TGTextView.

void TRootHelpDialog::SetText(const char *helpText)
{
   fView->LoadBuffer(helpText);
}

////////////////////////////////////////////////////////////////////////////////
/// Add help text from helpText buffer to already existing text in TGTextView.

void TRootHelpDialog::AddText(const char *helpText)
{
   TGText tt;
   tt.LoadBuffer(helpText);
   fView->AddText(&tt);
}

////////////////////////////////////////////////////////////////////////////////
/// Called when closed via window manager action.

void TRootHelpDialog::CloseWindow()
{
   DeleteWindow();
}

////////////////////////////////////////////////////////////////////////////////
/// Process OK button.

Bool_t TRootHelpDialog::ProcessMessage(Long_t msg, Long_t, Long_t)
{
   switch (GET_MSG(msg)) {
      case kC_COMMAND:
         switch (GET_SUBMSG(msg)) {
            case kCM_BUTTON:
               // Only one button and one action...
               DeleteWindow();
               break;
            default:
               break;
         }
      default:
         break;
   }

   return kTRUE;
}