library: libGui #include "TGDockableFrame.h"

# TGDockableFrame

class description - source file - inheritance tree (.pdf)

## class TGDockableFrame : public TGCompositeFrame, public TGWidget

| Inheritance Chart:
`TObject`
| <- | `TGObject`
| <- | `TGWindow`
`TQObject`
| <- | `TGFrame`
| <- | `TGCompositeFrame`
`TGWidget`
| <- | `TGDockableFrame` |

        public:

                            TGDockableFrame(const TGWindow* p = 0, Int_t id = -1, UInt_t options = kHorizontalFrame)
                            TGDockableFrame(const TGDockableFrame&)
                    virtual ~TGDockableFrame()
               virtual void AddFrame(TGFrame* f, TGLayoutHints* hints)
             static TClass* Class()
                       void DockContainer(Int_t del = kTRUE)
               virtual void Docked()
                       void EnableHide(Bool_t onoff)
                     Bool_t EnableHide() const
                       void EnableUndock(Bool_t onoff)
                     Bool_t EnableUndock() const
          TGCompositeFrame* GetContainer() const
                       void HideContainer()
            virtual TClass* IsA() const
                     Bool_t IsHidden() const
                     Bool_t IsUndocked() const
             virtual Bool_t ProcessMessage(Long_t, Long_t, Long_t)
               virtual void SavePrimitive(ofstream& out, Option_t* option)
               virtual void SetWindowName(const char* name)
                       void ShowContainer()
               virtual void ShowMembers(TMemberInspector& insp, char* parent)
               virtual void Streamer(TBuffer& b)
                       void StreamerNVirtual(TBuffer& b)
                       void UndockContainer()
               virtual void Undocked()

### Data Members

        protected:

                     Bool_t fHidden        if frame is hidden
                     Bool_t fEnableHide    if frame can be hidden
                     Bool_t fEnableUndock  if frame can be undocked
                     Bool_t fDeleted       kTRUE if it is being deleted
                    TString fDockName      name of frame
          TGCompositeFrame* fContainer     container containing dockable frame
          TGCompositeFrame* fButtons       container containing dock and hide buttons
              TGDockButton* fDockButton    dock button
          TGDockHideButton* fHideButton    hide button
           TGUndockedFrame* fFrame         undocked frame
             TGLayoutHints* fCl
             TGLayoutHints* fHints         layout hints

## Class Description

     A TGDockableFrame is a frame with handles that allow it to be
     undocked (i.e. put in a transient frame of its own) and to be docked
     again or hidden and shown again. It uses the TGDockButton, which is
     a button with two vertical bars (||) and TGDockHideButton, which is
     a button with a small triangle. The TGUndockedFrame is a transient
     frame that on closure will put the frame back in the dock.

TGDockableFrame(const TGWindow *p, int id, UInt_t /*options*/) : TGCompositeFrame(p, 10, 10, kHorizontalFrame), TGWidget(id)

     Create a dockable frame widget.

~TGDockableFrame()

     Cleanup dockable frame.

void AddFrame(TGFrame *f, TGLayoutHints *hints)

     Add frame to dockable frame container. Frame and hints are NOT adopted.

void UndockContainer()

     Undock container.

void DockContainer(Int_t del)

     Dock container back to TGDockableFrame.

void ShowContainer()

     Show dock container.

void HideContainer()

     Hide dock container.

Bool_t ProcessMessage(Long_t msg, Long_t parm1, Long_t)

     Process dockable frame messages.

void EnableUndock(Bool_t onoff)

     Enable undocking.

void EnableHide(Bool_t onoff)

     Enable hiding.

void SetWindowName(const char *name)

     Set window name so it appear as title of the undock window.

void SavePrimitive(ofstream &out, Option_t *option)

     Save a dockable frame widget as a C++ statement(s) on output stream out.

### Inline Functions

                         void Docked()
                         void Undocked()
                       Bool_t EnableUndock() const
                       Bool_t EnableHide() const
                       Bool_t IsUndocked() const
                       Bool_t IsHidden() const
            TGCompositeFrame* GetContainer() const
                      TClass* Class()
                      TClass* IsA() const
                         void ShowMembers(TMemberInspector& insp, char* parent)
                         void Streamer(TBuffer& b)
                         void StreamerNVirtual(TBuffer& b)
              TGDockableFrame TGDockableFrame(const TGDockableFrame&)

Author: Abdelhalim Ssadik 07/07/04
Last update: root/gui:$Name: $:$Id: TGDockableFrame.cxx,v 1.9 2005/06/09 17:44:40 brun Exp $
Copyright (C) 1995-2004, Rene Brun and Fons Rademakers. *