Methods Index

CDesktop

Description

A CDesktop object manages an application's "workspace" or screen window layout. It keeps track of the state of an application's windows. Every window that is created is put into the desktop.

A CDesktop object is instantiated automatically in CGlobalClassLib. You can access the desktop, and even replace it with your own derived version by using CGlobalClassLib GetDesktop and SetDesktop methods. You can also specify a different default desktop creation via the CApplicationFactory interface.

Protected Data Members

CApplication *itsApplication; The application to which it belongs
CWindow *itsFrontWindow; The front window
RWOrdered *itsWindowObjects; List of the windows
RWOrdered* itsModalStack; List of modal windows
RWOrdered* itsDialogObjects; List of dialogs


`CApplication`	`*itsApplication;`	The application to which it belongs
`CWindow`	`*itsFrontWindow;`	The front window
`RWOrdered`	`*itsWindowObjects;`	List of the windows
`RWOrdered*`	`itsModalStack;`	List of modal windows
`RWOrdered*`	`itsDialogObjects;`	List of dialogs

Friends

friend class CDocument;


`friend class`	`CDocument;`

Public Methods

Constructor, Destructor, and Initializer Methods

CDesktop(CApplication *theApplication);

A constructor. It takes a pointer to the application to which the desktop belongs (theApplication).

CDesktop(const CDesktop& theDesktop);

A copy constructor. It disallows the copying of a desktop.

CDesktop& operator=(const CDesktop& theDesktop);

An assignment operator, which disables the copying of a desktop.

virtual ~CDesktop(void);

The destructor. It cleans up after the desktop but does not destroy any windows.

Desktop Object Methods

virtual void SetFrontWindow(CWindow *theWindow);

Takes a pointer to a window (theWindow) and sets that window to the front of the window stack.

virtual CWindow* GetFrontWindow(void) const;

Returns a pointer to the window that is at the front of the window stack.

virtual int GetNumWindows(void) const;

Returns the number of windows in the desktop.

virtual void PlaceWindow(CWindow *theWindow);

A method that is called to place a window when it is created. You can override this method to meet your application's window placement needs.

BOOLEAN FindWindow(CWindow *theWindow) const;

Returns a BOOLEAN value of TRUE if theWindow is in the desktop and FALSE if it is not.

virtual const RWOrdered GetWindows(void) const;

A constant method that returns a list of windows that are known to the application.

void AddDialog(CDialog* theDialog);

Adds the specified dialog to the desktop.

void RemoveDialog(CDialog* theDialog);

Removes the specified dialog from the desktop.

virtual BOOLEAN DoClose(void);

Virtual method that may be overridden to clean up the desktop before the application is closed. If the method returns FALSE, the application will not be closed.

CView* GetKeyFocus(void) const;

Returns a pointer to the view that has the key focus in the application. If there is no such view, the method returns NULL.

void Closing(CWindow* win);

Cleans up the desktop for the specified window.

Protected Methods

Interaction With CDocument

virtual void AddWindow(CWindow *theWindow);

Adds theWindow to the desktop. Only

CDocument

virtual void RemoveWindow(CWindow *theWindow);

Removes theWindow from the desktop. Only

CDocument

Interaction With CSwitchBoard

void SetActiveWindow(CWindow *theWindow);

A method that is called internally when a user clicks on theWindow. It sets this window to an active state, which means that it is the selected window.

[Classes] [Prev] [Next] [Methods]

support@xvt.com

CDesktop

CDesktop

Heritage

Description

Usage

Protected Data Members

Friends

Public Methods

Constructor, Destructor, and Initializer Methods

Desktop Object Methods

Protected Methods

Interaction With CDocument

Interaction With CSwitchBoard