Defines top level windows that interact with the system Window Manager.

Definition at line 398 of file TGFrame.h.

Classes
class	TGMapKey

Public Member Functions
	TGMainFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=kVerticalFrame)
	Create a top level main frame.

virtual	~TGMainFrame ()
	TGMainFrame destructor.

virtual Bool_t	BindKey (const TGWindow *w, Int_t keycode, Int_t modifier) const
	Bind key to a window.

virtual void	CloseWindow ()
	Close and delete main frame.

void	DontCallClose ()
	Typically call this method in the slot connected to the CloseWindow() signal to prevent the calling of the default or any derived CloseWindow() methods to prevent premature or double deletion of this window.

TList *	GetBindList () const

void	GetClassHints (const char &className, const char &resourceName) const

const char *	GetIconName () const
	Returns mime type name of object.

const char *	GetIconPixmap () const

void	GetMWMHints (UInt_t &value, UInt_t &funcs, UInt_t &input) const

const char *	GetWindowName () const

void	GetWMPosition (Int_t &x, Int_t &y) const

void	GetWMSize (UInt_t &w, UInt_t &h) const

void	GetWMSizeHints (UInt_t &wmin, UInt_t &hmin, UInt_t &wmax, UInt_t &hmax, UInt_t &winc, UInt_t &hinc) const

EInitialState	GetWMState () const

virtual Bool_t	HandleButton (Event_t *event)
	Handle mouse button events.

virtual Bool_t	HandleClientMessage (Event_t *event)
	Handle client messages sent to this frame.

virtual Bool_t	HandleKey (Event_t *event)
	Handle keyboard events.

virtual Bool_t	HandleMotion (Event_t *event)
	Handle mouse motion events.

virtual Bool_t	HandleSelection (Event_t *event)
	Handle primary selection event.

virtual Bool_t	HandleSelectionRequest (Event_t *event)
	Handle selection request event.

virtual void	RemoveBind (const TGWindow *w, Int_t keycode, Int_t modifier) const
	Remove key binding.

virtual Bool_t	SaveFrameAsCodeOrImage ()
	Opens dialog window allowing user to save the frame contents as a ROOT macro or as an image.

virtual Bool_t	SaveFrameAsCodeOrImage (const TString &fileName)
	Saves the frame contents as a ROOT macro or as an image, depending on the extension of the fileName argument.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a main frame widget as a C++ statement(s) on output stream out.

virtual void	SaveSource (const char filename="Rootappl.C", Option_t option="")
	Save the GUI main frame widget in a C++ macro file.

virtual void	SendCloseMessage ()
	Send close message to self.

void	SetClassHints (const char className, const char resourceName)
	Set the windows class and resource name.

void	SetIconName (const char *name)
	Set window icon name. This is typically done via the window manager.

void	SetIconPixmap (char **xpm_array)
	Set window icon by xpm array.

const TGPicture *	SetIconPixmap (const char *iconName)
	Set window icon pixmap by name.

void	SetMWMHints (UInt_t value, UInt_t funcs, UInt_t input)
	Set decoration style for MWM-compatible wm (mwm, ncdwm, fvwm?).

void	SetWindowName (const char *name=0)
	Set window name. This is typically done via the window manager.

void	SetWMPosition (Int_t x, Int_t y)
	Give the window manager a window position hint.

void	SetWMSize (UInt_t w, UInt_t h)
	Give the window manager a window size hint.

void	SetWMSizeHints (UInt_t wmin, UInt_t hmin, UInt_t wmax, UInt_t hmax, UInt_t winc, UInt_t hinc)
	Give the window manager minimum and maximum size hints.

void	SetWMState (EInitialState state)
	Set the initial state of the window. Either kNormalState or kIconicState.

Public Member Functions inherited from TGCompositeFrame
	TGCompositeFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
	Create a composite frame.

	TGCompositeFrame (TGClient c, Window_t id, const TGWindow parent=nullptr)
	Create a frame using an externally created window.

virtual	~TGCompositeFrame ()
	Delete a composite frame.

virtual void	AddFrame (TGFrame f, TGLayoutHints l=0)
	Add frame to the composite frame using the specified layout hints.

virtual void	ChangeOptions (UInt_t options)
	Change composite frame options. Options is an OR of the EFrameTypes.

virtual void	ChangeSubframesBackground (Pixel_t back)
	Change background color for this frame and all subframes.

virtual void	Cleanup ()
	Cleanup and delete all objects contained in this composite frame.

virtual TGFrameElement *	FindFrameElement (TGFrame *f) const
	Find frame-element holding frame f.

virtual UInt_t	GetDefaultHeight () const

virtual TGDimension	GetDefaultSize () const
	std::cout << fWidth << "x" << fHeight << std::endl;

virtual UInt_t	GetDefaultWidth () const

virtual TGFrame *	GetFrameFromPoint (Int_t x, Int_t y)
	Get frame located at specified point.

virtual TGLayoutManager *	GetLayoutManager () const

virtual TList *	GetList () const

Int_t	GetState (TGFrame *f) const
	Get state of sub frame.

virtual Bool_t	HandleCrossing (Event_t *)

virtual Bool_t	HandleDoubleClick (Event_t *)

virtual Bool_t	HandleDragDrop (TGFrame frame, Int_t x, Int_t y, TGLayoutHints lo)
	Handle drop event.

virtual Bool_t	HandleDragEnter (TGFrame *)
	Handle drag enter event.

virtual Bool_t	HandleDragLeave (TGFrame *)
	Handle drag leave event.

virtual Bool_t	HandleDragMotion (TGFrame *)
	Handle drag motion event.

virtual Bool_t	HandleFocusChange (Event_t *)

virtual void	HideFrame (TGFrame *f)
	Hide sub frame.

Bool_t	IsArranged (TGFrame *f) const
	Get state of sub frame.

Bool_t	IsArranged (TGFrameElement *ptr) const

Bool_t	IsComposite () const

virtual Bool_t	IsEditable () const
	Return kTRUE if frame is being edited.

virtual Bool_t	IsLayoutBroken () const

virtual Bool_t	IsMapSubwindows () const

Bool_t	IsVisible (TGFrame *f) const
	Get state of sub frame.

Bool_t	IsVisible (TGFrameElement *ptr) const

virtual void	Layout ()
	Layout the elements of the composite frame.

virtual void	MapSubwindows ()
	Map all sub windows that are part of the composite frame.

virtual Int_t	MustCleanup () const

virtual void	Print (Option_t *option="") const
	Print all frames in this composite frame.

virtual Bool_t	ProcessMessage (Longptr_t, Longptr_t, Longptr_t)

virtual void	RemoveAll ()
	Remove all frames from composite frame.

virtual void	RemoveFrame (TGFrame *f)
	Remove frame from composite frame.

virtual void	SavePrimitiveSubframes (std::ostream &out, Option_t *option="")
	Auxiliary protected method used to save subframes.

virtual void	SetCleanup (Int_t mode=kLocalCleanup)
	Turn on automatic cleanup of child frames in dtor.

virtual void	SetEditable (Bool_t on=kTRUE)
	Switch ON/OFF edit mode.

virtual void	SetEditDisabled (UInt_t on=1)
	Set edit disable flag for this frame and subframes.

virtual void	SetLayoutBroken (Bool_t on=kTRUE)
	Set broken layout. No Layout method is called.

virtual void	SetLayoutManager (TGLayoutManager *l)
	Set the layout manager for the composite frame.

virtual void	SetMapSubwindows (Bool_t on)

virtual void	ShowFrame (TGFrame *f)
	Show sub frame.

virtual Bool_t	TranslateCoordinates (TGFrame *child, Int_t x, Int_t y, Int_t &fx, Int_t &fy)
	Translate coordinates to child frame.

Public Member Functions inherited from TGFrame
	TGFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
	Create a TGFrame object. Options is an OR of the EFrameTypes.

	TGFrame (TGClient c, Window_t id, const TGWindow parent=nullptr)
	Create a frame using an externally created window.

virtual	~TGFrame ()
	Destructor.

virtual void	Activate (Bool_t)

void	AddInput (UInt_t emask)
	Add events specified in the emask to the events the frame should handle.

virtual void	ChangeBackground (Pixel_t back)
	Change frame background color.

Bool_t	Contains (Int_t x, Int_t y) const

virtual void	Delete (Option_t *="")
	Delete this object.

virtual void	DeleteWindow ()
	Delete window.

virtual void	DrawBorder ()
	Draw frame border.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	DrawCopy (Handle_t, Int_t, Int_t)

virtual void	Dump () const
	Dump contents of object on stdout.

virtual Pixel_t	GetBackground () const

Int_t	GetBorderWidth () const

virtual TDNDData *	GetDNDData (Atom_t)

virtual Int_t	GetDragType () const
	Returns drag source type.

virtual Int_t	GetDropType () const
	Returns drop target type.

UInt_t	GetEventMask () const

virtual Pixel_t	GetForeground () const
	Return frame foreground color.

TGFrameElement *	GetFrameElement () const

UInt_t	GetHeight () const

UInt_t	GetMaxHeight () const

UInt_t	GetMaxWidth () const

UInt_t	GetMinHeight () const

UInt_t	GetMinWidth () const

virtual UInt_t	GetOptions () const

TGDimension	GetSize () const

UInt_t	GetWidth () const

Int_t	GetX () const

Int_t	GetY () const

virtual Bool_t	HandleColormapChange (Event_t *)

virtual Bool_t	HandleConfigureNotify (Event_t *event)
	This event is generated when the frame is resized.

virtual Bool_t	HandleDNDDrop (TDNDData *)

virtual Atom_t	HandleDNDEnter (Atom_t *)

virtual Bool_t	HandleDNDFinished ()

virtual Bool_t	HandleDNDLeave ()

virtual Atom_t	HandleDNDPosition (Int_t, Int_t, Atom_t, Int_t, Int_t)

virtual Bool_t	HandleEvent (Event_t *event)
	Handle all frame events.

virtual Bool_t	HandleSelectionClear (Event_t *)

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

virtual Bool_t	IsActive () const

Bool_t	IsDNDSource () const

Bool_t	IsDNDTarget () const

virtual void	MapRaised ()
	map raised

virtual void	MapWindow ()
	map window

virtual void	Move (Int_t x, Int_t y)
	Move frame.

virtual void	MoveResize (Int_t x, Int_t y, UInt_t w=0, UInt_t h=0)
	Move and/or resize the frame.

virtual void	ProcessedConfigure (Event_t *event)

virtual void	ProcessedEvent (Event_t *event)

virtual void	ReallyDelete ()

void	RemoveInput (UInt_t emask)
	Remove events specified in emask from the events the frame should handle.

virtual void	ReparentWindow (const TGWindow *p, Int_t x=0, Int_t y=0)
	Reparent window, make p the new parent and position the window at position (x,y) in new parent.

virtual void	Resize (TGDimension size)
	Resize the frame.

virtual void	Resize (UInt_t w=0, UInt_t h=0)
	Resize the frame.

void	SaveUserColor (std::ostream &out, Option_t *)
	Save a user color in a C++ macro file - used in SavePrimitive().

virtual void	SendMessage (const TGWindow *w, Longptr_t msg, Longptr_t parm1, Longptr_t parm2)
	Send message (i.e.

virtual void	SetBackgroundColor (Pixel_t back)
	Set background color (override from TGWindow base class).

void	SetDNDSource (Bool_t onoff)

void	SetDNDTarget (Bool_t onoff)

virtual void	SetDragType (Int_t type)
	SetDragType.

virtual void	SetDrawOption (Option_t *="")
	Set drawing option for object.

virtual void	SetDropType (Int_t type)
	SetDropType.

virtual void	SetForegroundColor (Pixel_t)

void	SetFrameElement (TGFrameElement *fe)

virtual void	SetHeight (UInt_t h)

virtual void	SetMaxHeight (UInt_t h)

virtual void	SetMaxWidth (UInt_t w)

virtual void	SetMinHeight (UInt_t h)

virtual void	SetMinWidth (UInt_t w)

virtual void	SetSize (const TGDimension &s)

virtual void	SetWidth (UInt_t w)

virtual void	SetX (Int_t x)

virtual void	SetY (Int_t y)

virtual void	UnmapWindow ()
	unmap window

Public Member Functions inherited from TGWindow
	TGWindow (const TGWindow p=0, Int_t x=0, Int_t y=0, UInt_t w=0, UInt_t h=0, UInt_t border=0, Int_t depth=0, UInt_t clss=0, void visual=0, SetWindowAttributes_t *attr=0, UInt_t wtype=0)
	Create a new window.

	TGWindow (TGClient c, Window_t id, const TGWindow parent=0)
	Create a copy of a window.

virtual	~TGWindow ()
	Window destructor. Unregisters the window.

virtual void	DestroySubwindows ()
	destroy sub windows

virtual void	DestroyWindow ()
	destroy window

virtual UInt_t	GetEditDisabled () const

virtual const TGWindow *	GetMainFrame () const
	Returns top level main frame.

virtual const char *	GetName () const
	Return unique name, used in SavePrimitive methods.

const TGWindow *	GetParent () const

virtual Bool_t	HandleExpose (Event_t *event)

virtual Bool_t	HandleIdleEvent (TGIdleHandler *)

virtual Bool_t	HandleTimer (TTimer *)
	Execute action in response of a timer timing out.

virtual void	IconifyWindow ()
	iconify window

virtual Bool_t	IsMapped ()
	Returns kTRUE if window is mapped on screen, kFALSE otherwise.

virtual void	LowerWindow ()
	lower window

virtual void	RaiseWindow ()
	raise window

virtual void	RequestFocus ()
	request focus

virtual void	SetBackgroundPixmap (Pixmap_t pixmap)
	set background pixmap

virtual void	SetName (const char *name)

Public Member Functions inherited from TGObject
	TGObject ()

	TGObject (const TGObject &tgo)

virtual	~TGObject ()
	TGObject destructor.

TGClient *	GetClient () const

Handle_t	GetId () const

ULong_t	Hash () const
	Return hash value for this object.

Bool_t	IsEqual (const TObject *obj) const
	Equal comparison (TGObjects are equal if they have the same window identifier).

virtual void	SaveAs (const char filename="", Option_t option="") const
	Write this TGObject to a file using TImage, if filename's extension signals a valid TImage::EImageFileType, as defined by TImage::GetImageFileTypeFromFilename().

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor.

virtual	~TQObject ()
	TQObject Destructor.

Bool_t	AreSignalsBlocked () const

Bool_t	BlockSignals (Bool_t b)

virtual void	ChangedBy (const char *method)

void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes.

Bool_t	Connect (const char signal, const char receiver_class, void receiver, const char slot)
	Non-static method is used to connect from the signal of this object to the receiver slot.

virtual void	Connected (const char *)

virtual void	Destroyed ()

Bool_t	Disconnect (const char signal=0, void receiver=0, const char *slot=0)
	Disconnects signal of this object from slot of receiver.

virtual void	Disconnected (const char *)

void	Emit (const char *signal)
	Activate signal without args.

template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter.

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments.

TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class.

TList *	GetListOfConnections () const

TList *	GetListOfSignals () const

virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal.

virtual void	HighPriority (const char signal_name, const char slot_name=0)

virtual void	LowPriority (const char signal_name, const char slot_name=0)

virtual void	Message (const char *msg)

virtual Int_t	NumberOfConnections () const
	Return number of connections for this object.

virtual Int_t	NumberOfSignals () const
	Return number of signals for this object.

Protected Types
enum	{ kDontCallClose = BIT(14) }

Protected Types inherited from TGFrame
enum	{ kDeleteWindowCalled = BIT(15) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Protected Member Functions
TString	GetMWMfuncString () const
	used in SaveSource()

TString	GetMWMinpString () const
	used in SaveSource()

TString	GetMWMvalueString () const
	used in SaveSource()

Protected Member Functions inherited from TGFrame
virtual void	DoRedraw ()
	Redraw the frame.

virtual void	Draw3dRectangle (UInt_t type, Int_t x, Int_t y, UInt_t w, UInt_t h)
	Draw 3D rectangle on the frame border.

TString	GetOptionString () const
	Returns a frame option string - used in SavePrimitive().

const TGResourcePool *	GetResourcePool () const

virtual void *	GetSender ()

virtual void	StartGuiBuilding (Bool_t on=kTRUE)
	Go into GUI building mode.

Protected Member Functions inherited from TGWindow
	TGWindow (const TGWindow &tgw)

	TGWindow (Window_t id)

TGWindow &	operator= (const TGWindow &tgw)

Protected Member Functions inherited from TGObject
TGObject &	operator= (const TGObject &tgo)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Member Functions inherited from TQObject
virtual const char *	GetSenderClassName () const

Protected Attributes
TList *	fBindList
	list with key bindings

TString	fClassName
	WM class name.

Atom_t *	fDNDTypeList
	handles DND types

TString	fIconName
	icon name

TString	fIconPixmap
	icon pixmap name

UInt_t	fMWMFuncs
	MWM functions.

UInt_t	fMWMInput
	MWM input modes.

UInt_t	fMWMValue
	MWM decoration hints.

TString	fResourceName
	WM resource name.

TString	fWindowName
	window name

UInt_t	fWMHeight
	WM height.

UInt_t	fWMHeightInc
	WM height increments.

EInitialState	fWMInitState
	WM initial state.

UInt_t	fWMMaxHeight
	WM max height.

UInt_t	fWMMaxWidth
	WM max width.

UInt_t	fWMMinHeight
	WM min height.

UInt_t	fWMMinWidth
	WM min width.

UInt_t	fWMWidth
	WM width.

UInt_t	fWMWidthInc
	WM width increments.

Int_t	fWMX
	WM x position.

Int_t	fWMY
	WM y position.

Protected Attributes inherited from TGCompositeFrame
Bool_t	fLayoutBroken
	no layout manager is used

TGLayoutManager *	fLayoutManager
	layout manager

TList *	fList
	container of frame elements

Bool_t	fMapSubwindows
	kTRUE - map subwindows

Int_t	fMustCleanup
	cleanup mode (see EFrameCleanup)

Protected Attributes inherited from TGFrame
Pixel_t	fBackground
	frame background color

Int_t	fBorderWidth
	frame border width

Int_t	fDNDState
	EDNDFlags.

UInt_t	fEventMask
	currently active event mask

TGFrameElement *	fFE
	pointer to frame element

UInt_t	fHeight
	frame height

UInt_t	fMaxHeight
	maximal frame height

UInt_t	fMaxWidth
	maximal frame width

UInt_t	fMinHeight
	minimal frame height

UInt_t	fMinWidth
	minimal frame width

UInt_t	fOptions
	frame options

UInt_t	fWidth
	frame width

Int_t	fX
	frame x position

Int_t	fY
	frame y position

Protected Attributes inherited from TGWindow
UInt_t	fEditDisabled
	flags used for "guibuilding"

TString	fName
	name of the window used in SavePrimitive()

Bool_t	fNeedRedraw
	kTRUE if window needs to be redrawn

const TGWindow *	fParent
	Parent window.

Protected Attributes inherited from TGObject
TGClient *	fClient
	Connection to display server.

Handle_t	fId
	X11/Win32 Window identifier.

Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object

Private Member Functions
	TGMainFrame (const TGMainFrame &)=delete

TGMainFrame &	operator= (const TGMainFrame &)=delete

Additional Inherited Members
Public Types inherited from TGWindow
enum	EEditMode { kEditEnable = 0 , kEditDisable = BIT(0) , kEditDisableEvents = BIT(1) , kEditDisableGrab = BIT(2) , kEditDisableLayout = BIT(3) , kEditDisableResize = BIT(4) , kEditDisableHeight = BIT(5) , kEditDisableWidth = BIT(6) , kEditDisableBtnEnable = BIT(7) , kEditDisableKeyEnable = BIT(8) }

enum	EStatusBits { kIsHtmlView = BIT(14) }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TGFrame
static const TGGC &	GetBckgndGC ()
	Get background color graphics context.

static const TGGC &	GetBlackGC ()
	Get black graphics context.

static Pixel_t	GetBlackPixel ()
	Get black pixel value.

static Pixel_t	GetDefaultFrameBackground ()
	Get default frame background.

static Pixel_t	GetDefaultSelectedBackground ()
	Get default selected frame background.

static const TGGC &	GetHilightGC ()
	Get highlight color graphics context.

static const TGGC &	GetShadowGC ()
	Get shadow color graphics context.

static const TGGC &	GetWhiteGC ()
	Get white graphics context.

static Pixel_t	GetWhitePixel ()
	Get white pixel value.

Static Public Member Functions inherited from TGWindow
static Int_t	GetCounter ()
	Return global window counter (total number of created windows).

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.

static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status.

static Bool_t	Connect (const char sender_class, const char signal, const char receiver_class, void receiver, const char *slot)
	This method allows to make a connection from any object of the same class to a single slot.

static Bool_t	Connect (TQObject sender, const char signal, const char receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

static Bool_t	Disconnect (const char class_name, const char signal, void receiver=0, const char slot=0)
	Disconnects "class signal".

static Bool_t	Disconnect (TQObject sender, const char signal=0, void receiver=0, const char slot=0)
	Disconnects signal in object sender from slot_method in object receiver.

Static Protected Member Functions inherited from TGFrame
static Time_t	GetLastClick ()
	Get time of last mouse click.

Static Protected Member Functions inherited from TQObject
static Int_t	CheckConnectArgs (TQObject sender, TClass sender_class, const char signal, TClass receiver_class, const char *slot)
	Checking of consistency of sender/receiver methods/arguments.

static TString	CompressName (const char *method_name)
	Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature.

static Bool_t	ConnectToClass (const char sender_class, const char signal, TClass receiver_class, void receiver, const char *slot)
	This method allows to make connection from any object of the same class to the receiver object.

static Bool_t	ConnectToClass (TQObject sender, const char signal, TClass receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

Static Protected Attributes inherited from TGCompositeFrame
static TGLayoutHints *	fgDefaultHints = nullptr

Static Protected Attributes inherited from TGFrame
static const TGGC *	fgBckgndGC = nullptr

static const TGGC *	fgBlackGC = nullptr

static Pixel_t	fgBlackPixel = 0

static Window_t	fgDbw = 0

static Int_t	fgDbx = 0

static Int_t	fgDby = 0

static Pixel_t	fgDefaultFrameBackground = 0

static Pixel_t	fgDefaultSelectedBackground = 0

static const TGGC *	fgHilightGC = nullptr

static Bool_t	fgInit = kFALSE

static UInt_t	fgLastButton = 0

static Time_t	fgLastClick = 0

static const TGGC *	fgShadowGC = nullptr

static UInt_t	fgUserColor = 0

static const TGGC *	fgWhiteGC = nullptr

static Pixel_t	fgWhitePixel = 0

Static Protected Attributes inherited from TGWindow
static Int_t	fgCounter = 0
	counter of created windows in SavePrimitive

Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals

#include <TGFrame.h>

Inheritance diagram for TGMainFrame:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
kDontCallClose

Definition at line 401 of file TGFrame.h.

Constructor & Destructor Documentation

◆ TGMainFrame() [1/2]

TGMainFrame::TGMainFrame ( const TGMainFrame & )

privatedelete

◆ TGMainFrame() [2/2]

TGMainFrame::TGMainFrame	(	const TGWindow *	p = `nullptr`,
		UInt_t	w = `1`,
		UInt_t	h = `1`,
		UInt_t	options = `kVerticalFrame`
	)

Create a top level main frame.

A main frame interacts with the window manager.

Definition at line 1444 of file TGFrame.cxx.

◆ ~TGMainFrame()

TGMainFrame::~TGMainFrame ( )

virtual

TGMainFrame destructor.

Definition at line 1507 of file TGFrame.cxx.

Member Function Documentation

◆ BindKey()

Bool_t TGMainFrame::BindKey	(	const TGWindow *	w,
		Int_t	keycode,
		Int_t	modifier
	)		const

virtual

Bind key to a window.

Definition at line 1637 of file TGFrame.cxx.

◆ CloseWindow()

void TGMainFrame::CloseWindow ( )

virtual

Close and delete main frame.

We get here in response to ALT+F4 or a window manager close command. To terminate the application when this happens override this method and call gApplication->Terminate(0) or make a connection to this signal (if after the slot this method should not be called call DontCallClose() in the slot). By default the window will be deleted.

Reimplemented in TGeoTransientPanel, TASPaletteEditor, TEveBrowser, TEveGedEditor, TGLSAFrame, TStructViewerGUI, TFitEditor, TFitParametersDialog, TFunctionParametersDialog, TGedEditor, TStyleManager, TGColorDialog, TGUndockedFrame, TGFileDialog, TGFontDialog, TGMsgBox, TGSearchDialog, TGPrintDialog, TGGotoDialog, TGTextEditor, TRootCanvas, TRootControlBar, TRootDialog, TRootHelpDialog, TRootGuiBuilder, TGuiBldMenuDialog, TProofProgressLog, TNewChainDlg, TNewQueryDlg, TUploadDataSetDlg, TSessionLogView, TSessionViewer, TTreeViewer, TGSelectBox, TRootBrowser, and TRootBrowserLite.

Definition at line 1770 of file TGFrame.cxx.

◆ DontCallClose()

void TGMainFrame::DontCallClose ( )

Typically call this method in the slot connected to the CloseWindow() signal to prevent the calling of the default or any derived CloseWindow() methods to prevent premature or double deletion of this window.

Definition at line 1780 of file TGFrame.cxx.

◆ GetBindList()

TList * TGMainFrame::GetBindList ( ) const

inline

Definition at line 475 of file TGFrame.h.

◆ GetClassHints()

void TGMainFrame::GetClassHints	(	const char *&	className,
		const char *&	resourceName
	)		const

inline

Definition at line 480 of file TGFrame.h.

◆ GetIconName()

const char * TGMainFrame::GetIconName ( ) const

inlinevirtual

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented from TObject.

Definition at line 478 of file TGFrame.h.

◆ GetIconPixmap()

const char * TGMainFrame::GetIconPixmap ( ) const

inline

Definition at line 479 of file TGFrame.h.

◆ GetMWMfuncString()

TString TGMainFrame::GetMWMfuncString ( ) const

protected

used in SaveSource()

Returns MWM function hints as a string - used in SavePrimitive().

Definition at line 2610 of file TGFrame.cxx.

◆ GetMWMHints()

void TGMainFrame::GetMWMHints	(	UInt_t &	value,
		UInt_t &	funcs,
		UInt_t &	input
	)		const

inline

Definition at line 482 of file TGFrame.h.

◆ GetMWMinpString()

TString TGMainFrame::GetMWMinpString ( ) const

protected

used in SaveSource()

Returns MWM input mode hints as a string - used in SavePrimitive().

Definition at line 2647 of file TGFrame.cxx.

◆ GetMWMvalueString()

TString TGMainFrame::GetMWMvalueString ( ) const

protected

used in SaveSource()

Returns MWM decoration hints as a string - used in SavePrimitive().

Definition at line 2570 of file TGFrame.cxx.

◆ GetWindowName()

const char * TGMainFrame::GetWindowName ( ) const

inline

Definition at line 477 of file TGFrame.h.

◆ GetWMPosition()

void TGMainFrame::GetWMPosition	(	Int_t &	x,
		Int_t &	y
	)		const

inline

Definition at line 484 of file TGFrame.h.

◆ GetWMSize()

void TGMainFrame::GetWMSize	(	UInt_t &	w,
		UInt_t &	h
	)		const

inline

Definition at line 485 of file TGFrame.h.

◆ GetWMSizeHints()

void TGMainFrame::GetWMSizeHints	(	UInt_t &	wmin,
		UInt_t &	hmin,
		UInt_t &	wmax,
		UInt_t &	hmax,
		UInt_t &	winc,
		UInt_t &	hinc
	)		const

inline

Definition at line 486 of file TGFrame.h.

◆ GetWMState()

EInitialState TGMainFrame::GetWMState ( ) const

inline

Definition at line 490 of file TGFrame.h.

◆ HandleButton()

Bool_t TGMainFrame::HandleButton ( Event_t * event )

virtual

Handle mouse button events.

Reimplemented from TGCompositeFrame.

Definition at line 1679 of file TGFrame.cxx.

◆ HandleClientMessage()

Bool_t TGMainFrame::HandleClientMessage ( Event_t * event )

virtual

Handle client messages sent to this frame.

Reimplemented from TGFrame.

Definition at line 1727 of file TGFrame.cxx.

◆ HandleKey()

Bool_t TGMainFrame::HandleKey ( Event_t * event )

virtual

Handle keyboard events.

Reimplemented from TGCompositeFrame.

Reimplemented in TGMsgBox, TGTextEditor, TRootDialog, TRootGuiBuilder, TRootBrowser, and TRootBrowserLite.

Definition at line 1606 of file TGFrame.cxx.

◆ HandleMotion()

Bool_t TGMainFrame::HandleMotion ( Event_t * event )

virtual

Handle mouse motion events.

Reimplemented from TGCompositeFrame.

Definition at line 1691 of file TGFrame.cxx.

◆ HandleSelection()

Bool_t TGMainFrame::HandleSelection ( Event_t * event )

virtual

Handle primary selection event.

Reimplemented from TGCompositeFrame.

Definition at line 1703 of file TGFrame.cxx.

◆ HandleSelectionRequest()

Bool_t TGMainFrame::HandleSelectionRequest ( Event_t * event )

virtual

Handle selection request event.

Reimplemented from TGFrame.

Definition at line 1715 of file TGFrame.cxx.

◆ operator=()

TGMainFrame & TGMainFrame::operator= ( const TGMainFrame & )

privatedelete

◆ RemoveBind()

void TGMainFrame::RemoveBind	(	const TGWindow *	w,
		Int_t	keycode,
		Int_t	modifier
	)		const

virtual

Remove key binding.

Definition at line 1660 of file TGFrame.cxx.

◆ SaveFrameAsCodeOrImage() [1/2]

Bool_t TGMainFrame::SaveFrameAsCodeOrImage ( )

virtual

Opens dialog window allowing user to save the frame contents as a ROOT macro or as an image.

Returns kTRUE if something was saved.

This is bound to Ctrl-S by default.

Definition at line 1527 of file TGFrame.cxx.

◆ SaveFrameAsCodeOrImage() [2/2]

Bool_t TGMainFrame::SaveFrameAsCodeOrImage ( const TString & fileName )

virtual

Saves the frame contents as a ROOT macro or as an image, depending on the extension of the fileName argument.

If preexisting, the file is overwritten. Returns kTRUE if something was saved.

Definition at line 1564 of file TGFrame.cxx.

◆ SavePrimitive()

void TGMainFrame::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = `""`
	)

virtual

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

Reimplemented from TGCompositeFrame.

Reimplemented in TGTransientFrame.

Definition at line 3093 of file TGFrame.cxx.

◆ SaveSource()

void TGMainFrame::SaveSource	(	const char *	filename = `"Rootappl.C"`,
		Option_t *	option = `""`
	)

virtual

Save the GUI main frame widget in a C++ macro file.

Reimplemented in TTreeViewer, and TGTransientFrame.

Definition at line 2815 of file TGFrame.cxx.

◆ SendCloseMessage()

void TGMainFrame::SendCloseMessage ( )

virtual

Send close message to self.

This method should be called from a button to close this window.

Definition at line 1744 of file TGFrame.cxx.

◆ SetClassHints()

void TGMainFrame::SetClassHints	(	const char *	className,
		const char *	resourceName
	)

Set the windows class and resource name.

Used to get the right resources from the resource database. However, ROOT applications will typically use the .rootrc file for this.

Definition at line 1856 of file TGFrame.cxx.

◆ SetIconName()

void TGMainFrame::SetIconName ( const char * name )

Set window icon name. This is typically done via the window manager.

Definition at line 1801 of file TGFrame.cxx.

◆ SetIconPixmap() [1/2]

void TGMainFrame::SetIconPixmap ( char ** xpm_array )

Set window icon by xpm array.

That allows to have icons builtin to the source code.

For example, #include "/home/root/icons/bld_rgb.xpm" //bld_rgb.xpm contains char *bld_rgb[] array main_frame->SetIconPixmap(bld_rgb);

Definition at line 1837 of file TGFrame.cxx.

◆ SetIconPixmap() [2/2]

const TGPicture * TGMainFrame::SetIconPixmap ( const char * iconName )

Set window icon pixmap by name.

This is typically done via the window manager. Icon can be in any image format supported by TImage, e.g. GIF, XPM, PNG, JPG .. or even PS, PDF (see EImageFileTypes in TImage.h for the full list of supported formats).

For example, main_frame->SetIconPixmap("/home/root/icons/bld_rgb.png");

Definition at line 1816 of file TGFrame.cxx.

◆ SetMWMHints()

void TGMainFrame::SetMWMHints	(	UInt_t	value,
		UInt_t	funcs,
		UInt_t	input
	)

Set decoration style for MWM-compatible wm (mwm, ncdwm, fvwm?).

Definition at line 1866 of file TGFrame.cxx.

◆ SetWindowName()

void TGMainFrame::SetWindowName ( const char * name = 0 )

virtual

Set window name. This is typically done via the window manager.

Reimplemented from TGWindow.

Definition at line 1788 of file TGFrame.cxx.

◆ SetWMPosition()

void TGMainFrame::SetWMPosition	(	Int_t	x,
		Int_t	y
	)

Give the window manager a window position hint.

Definition at line 1879 of file TGFrame.cxx.

◆ SetWMSize()

void TGMainFrame::SetWMSize	(	UInt_t	w,
		UInt_t	h
	)

Give the window manager a window size hint.

Definition at line 1891 of file TGFrame.cxx.

◆ SetWMSizeHints()

void TGMainFrame::SetWMSizeHints	(	UInt_t	wmin,
		UInt_t	hmin,
		UInt_t	wmax,
		UInt_t	hmax,
		UInt_t	winc,
		UInt_t	hinc
	)

Give the window manager minimum and maximum size hints.

Also specify via winc and hinc the resize increments.

Definition at line 1904 of file TGFrame.cxx.

◆ SetWMState()

void TGMainFrame::SetWMState ( EInitialState state )

Set the initial state of the window. Either kNormalState or kIconicState.

Definition at line 1922 of file TGFrame.cxx.

Member Data Documentation

◆ fBindList

TList* TGMainFrame::fBindList

protected

list with key bindings

Definition at line 415 of file TGFrame.h.

◆ fClassName

TString TGMainFrame::fClassName

protected

WM class name.

Definition at line 419 of file TGFrame.h.

◆ fDNDTypeList

Atom_t* TGMainFrame::fDNDTypeList

protected

handles DND types

Definition at line 414 of file TGFrame.h.

◆ fIconName

TString TGMainFrame::fIconName

protected

icon name

Definition at line 417 of file TGFrame.h.

◆ fIconPixmap

TString TGMainFrame::fIconPixmap

protected

icon pixmap name

Definition at line 418 of file TGFrame.h.

◆ fMWMFuncs

UInt_t TGMainFrame::fMWMFuncs

protected

MWM functions.

Definition at line 422 of file TGFrame.h.

◆ fMWMInput

UInt_t TGMainFrame::fMWMInput

protected

MWM input modes.

Definition at line 423 of file TGFrame.h.

◆ fMWMValue

UInt_t TGMainFrame::fMWMValue

protected

MWM decoration hints.

Definition at line 421 of file TGFrame.h.

◆ fResourceName

TString TGMainFrame::fResourceName

protected

WM resource name.

Definition at line 420 of file TGFrame.h.

◆ fWindowName

TString TGMainFrame::fWindowName

protected

window name

Definition at line 416 of file TGFrame.h.

◆ fWMHeight

UInt_t TGMainFrame::fWMHeight

protected

WM height.

Definition at line 427 of file TGFrame.h.

◆ fWMHeightInc

UInt_t TGMainFrame::fWMHeightInc

protected

WM height increments.

Definition at line 433 of file TGFrame.h.

◆ fWMInitState

EInitialState TGMainFrame::fWMInitState

protected

WM initial state.

Definition at line 434 of file TGFrame.h.

◆ fWMMaxHeight

UInt_t TGMainFrame::fWMMaxHeight

protected

WM max height.

Definition at line 431 of file TGFrame.h.

◆ fWMMaxWidth

UInt_t TGMainFrame::fWMMaxWidth

protected

WM max width.

Definition at line 430 of file TGFrame.h.

◆ fWMMinHeight

UInt_t TGMainFrame::fWMMinHeight

protected

WM min height.

Definition at line 429 of file TGFrame.h.

◆ fWMMinWidth

UInt_t TGMainFrame::fWMMinWidth

protected

WM min width.

Definition at line 428 of file TGFrame.h.

◆ fWMWidth

UInt_t TGMainFrame::fWMWidth

protected

WM width.

Definition at line 426 of file TGFrame.h.

◆ fWMWidthInc

UInt_t TGMainFrame::fWMWidthInc

protected

WM width increments.

Definition at line 432 of file TGFrame.h.

◆ fWMX

Int_t TGMainFrame::fWMX

protected

WM x position.

Definition at line 424 of file TGFrame.h.

◆ fWMY

Int_t TGMainFrame::fWMY

protected

WM y position.

Definition at line 425 of file TGFrame.h.

Libraries for TGMainFrame:

[legend]

The documentation for this class was generated from the following files:

gui/gui/inc/TGFrame.h
gui/gui/src/TGFrame.cxx

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TGMainFrame() [1/2]

◆ TGMainFrame() [2/2]

◆ ~TGMainFrame()

Member Function Documentation

◆ BindKey()

◆ CloseWindow()

◆ DontCallClose()

◆ GetBindList()

◆ GetClassHints()

◆ GetIconName()

◆ GetIconPixmap()

◆ GetMWMfuncString()

◆ GetMWMHints()

◆ GetMWMinpString()

◆ GetMWMvalueString()

◆ GetWindowName()

◆ GetWMPosition()

◆ GetWMSize()

◆ GetWMSizeHints()

◆ GetWMState()

◆ HandleButton()

◆ HandleClientMessage()

◆ HandleKey()

◆ HandleMotion()

◆ HandleSelection()

◆ HandleSelectionRequest()

◆ operator=()

◆ RemoveBind()

◆ SaveFrameAsCodeOrImage() [1/2]

◆ SaveFrameAsCodeOrImage() [2/2]

◆ SavePrimitive()

◆ SaveSource()

◆ SendCloseMessage()

◆ SetClassHints()

◆ SetIconName()

◆ SetIconPixmap() [1/2]

◆ SetIconPixmap() [2/2]

◆ SetMWMHints()

◆ SetWindowName()

◆ SetWMPosition()

◆ SetWMSize()

◆ SetWMSizeHints()

◆ SetWMState()

Member Data Documentation

◆ fBindList

◆ fClassName

◆ fDNDTypeList

◆ fIconName

◆ fIconPixmap

◆ fMWMFuncs

◆ fMWMInput

◆ fMWMValue

◆ fResourceName

◆ fWindowName

◆ fWMHeight

◆ fWMHeightInc

◆ fWMInitState

◆ fWMMaxHeight

◆ fWMMaxWidth

◆ fWMMinHeight

◆ fWMMinWidth

◆ fWMWidth

◆ fWMWidthInc

◆ fWMX

◆ fWMY