Window Class Reference

The basic object in which to display data to the user. More...

#include <Window.h>

Inheritance diagram for Window:

List of all members.

Public Member Functions
virtual void	setName (const std::string &windowName)=0
virtual WindowType	getWindowType () const =0
virtual void	enableSessionItemDrops (SessionItemDropFilter *pFilter=NULL)=0
Static Public Member Functions
static const std::string &	signalSessionItemDropped ()
static const std::string &	signalSessionItemsDropped ()
Protected Member Functions
virtual	~Window ()
Classes
class	SessionItemDropFilter
	This interface is implemented by objects wishing to selectively accept drop events. More...

---

Detailed Description

The basic object in which to display data to the user.

This class is a base class for displaying data to the user. The main application can create and manage several types of windows. Every window has a name and a type that is used to uniquely identify itself within the application.

This subclass of Subject will notify upon the following conditions:

• The following method is called: setName().
• Everything else documented in Subject.

See also:

DesktopServices

Definition at line 33 of file Window.h.

---

Constructor & Destructor Documentation

virtual Window::~Window

(

)

[protected, virtual]

This should be destroyed by calling DesktopServices::deleteWindow.

Definition at line 112 of file Window.h.

---

Member Function Documentation

static const std::string& Window::signalSessionItemDropped

(

)

[static]

Emitted with any<SessionItem*> for each SessionItem dropped onto the window.

If a single signal with all SessionItems involved in a dropEvent() is needed, see signalSessionItemsDropped().

Definition at line 63 of file Window.h.

static const std::string& Window::signalSessionItemsDropped

(

)

[static]

Emitted with any<vector<SessionItem*> > when one or more SessionItems are dropped onto the window.

All SessionItems are included in this signal. See signalSessionItemDropped() if a separate signal for each SessionItem is needed.

Definition at line 70 of file Window.h.

virtual void Window::setName

(

const std::string &

windowName

)

[pure virtual]

Sets the window name.

Parameters:

windowName

The new name for the window. Cannot be empty.

Subject Notifications:

This method will notify Subject::signalModified.

virtual WindowType Window::getWindowType

(

)

const [pure virtual]

Returns the window type.

Returns:

The window type.

See also:

WindowType

virtual void Window::enableSessionItemDrops

(

SessionItemDropFilter *

pFilter = NULL

)

[pure virtual]

Enable dropping of SessionItems via drag and drop.

Windows can accept drag and drop events by calling this method. Once enabled signalSessionItemDropped() is emmitted for each SessionItem dropped into this Window. If the caller wishes to selectively accept drops, the SessionItemDropFilter parameter should be non-null.

Parameters:

pFilter

If this is NULL, all SessionItems will be accepted. If non-NULL, the filter will be added to the filter list. Each filter registered will be checked for acceptance of the drop until one accepts. The caller maintains ownership of the filter.