// Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// Shells for window server window functions.

// 

//

#include <e32std.h>

#include "../SERVER/w32cmd.h"

#include "CLIENT.H"

#include "w32comm.h"

RWindowTreeNode::RWindowTreeNode()

/** Protected default constructor.

This creates a sessionless, uninitialised window tree node handle. This class 

is not for user derivation; however derived classes form part of the Window 

Server API.

Because RWindowTreeNode and its derived classes are lightweight handles, if 

your class contains an object of such a class, the object should be an inline 

member rather than a pointer member.

This default constructor allows you to instantiate such an inline member before 

the class that contains it has created a window server session. If you do this, 

you will need to call the RWindowTreeNode constructor that takes an RWsSession 

parameter before you can use the member, because RWindowTreeNode-derived objects 

must have a reference to a window server session in order to be valid. */

	{}

RWindowTreeNode::RWindowTreeNode(RWsSession &aWs) : MWsClientClass(aWs.iBuffer)

/** Protected constructor which creates an uninitialised window tree node handle 

within a server session. 

This class is not for user derivation; however derived classes form part of 

the standard Window Server API, and are constructed with a public 

constructor with the same signature as this one.

@param aWs Window server session. */

	{}

RWindowBase::RWindowBase() : RWindowTreeNode()

/** Protected default constructor; creates an uninitialised, sessionless window 

handle.

Handles to server-side objects must be created in a session in order to be 

operational; this constructor is merely a convenience to allow the handle 

to be stored as a data member. See RWindowTreeNode::RWindowTreeNode() for 

details of how the complete setup of a handle field may be deferred until 

the window server session is known. */

	{}

RWindowBase::RWindowBase(RWsSession &aWs) : RWindowTreeNode(aWs)

/** Protected constructor; creates an uninitialised window handle within a session.

@param aWs Window server session. */

	{}

RDrawableWindow::RDrawableWindow() : RWindowBase()

/** Protected default constructor which creates a sessionless, uninitialised drawable-window 

handle.

Handles to server-side objects must be created in a session in order to be 

operational; this constructor is merely a convenience to allow the handle 

to be stored as a data member. See RWindowTreeNode::RWindowTreeNode() for 

details of how the complete setup of a handle field may be deferred until 

the window server session is known */

	{}

RDrawableWindow::RDrawableWindow(RWsSession &aWs) : RWindowBase(aWs)

/** Protected default constructor which creates an initialised drawable-window 

handle within a server session.

@param aWs Window server session. */

	{}

EXPORT_C RWindow::RWindow() : RDrawableWindow()

/** Default constructor which creates a sessionless, uninitialised window handle. 

Handles to server-side objects must be created in a session in order to be 

operational; this constructor is merely a convenience to allow the handle 

to be stored as a data member. See RWindowTreeNode::RWindowTreeNode() for 

details of how the complete setup of a handle field may be deferred until 

the window server session is known. */

	{}

EXPORT_C RWindow::RWindow(RWsSession &aWs) : RDrawableWindow(aWs)

/** Constructor which creates an initialised window handle within a server session.

@param aWs Window server session to use. */

	{}

EXPORT_C RBackedUpWindow::RBackedUpWindow() : RDrawableWindow()

/** Default C++ constructor which creates a sessionless backed-up window handle.

Handles to server-side objects must be created in a session in order to be 

operational; this constructor is merely a convenience to allow the handle 

to be stored as a data member. See RWindowTreeNode::RWindowTreeNode() for 

details of how the complete setup of a handle field may be deferred until 

the window server session is known. */

	{}

EXPORT_C RBackedUpWindow::RBackedUpWindow(RWsSession &aWs) : RDrawableWindow(aWs)

/** Constructor which creates an uninitialised backed-up window handle within a 

session.

@param aWs The window server session that owns the window. */

	{}

EXPORT_C RBlankWindow::RBlankWindow() : RWindowBase()

/** Default C++ constructor which creates an invalid blank-window handle. 

See RWindowTreeNode::RWindowTreeNode() for details of how the complete setup 

of a handle field may be deferred until the window server session is known. */

	{}

EXPORT_C RBlankWindow::RBlankWindow(RWsSession &aWs) : RWindowBase(aWs)

/** Default C++ constructor which creates a valid but uninitialised blank-window 

handle. 

This constructor does not create a window in the window server: client programs 

must do this by calling RBlankWindow::Construct() before any operations can 

be carried out on the window.

@param aWs The window server session that owns the window. */

	{}

EXPORT_C RWindowGroup::RWindowGroup() : RWindowTreeNode()

/** Creates a sessionless, uninitialised window group handle.

Handles to server-side objects must be created in a session in order to be 

operational; this constructor is merely a convenience to allow the handle 

to be stored as a data member. See RWindowTreeNode::RWindowTreeNode() for 

details of how the complete setup of a handle field may be deferred until 

the window server session is known. */

	{}

EXPORT_C RWindowGroup::RWindowGroup(RWsSession &aWs) : RWindowTreeNode(aWs)

/** Creates an initialised window group handle within a server session.

@param aWs The window server session owning the window group. */

	{}

EXPORT_C void RWindowTreeNode::Close()

/** Closes the node. 

This function should be called on all windows once they are no longer needed. 

It causes the window server to destroy the server-side window, and frees client-side 

resources owned by the window.

Note: When Close() is called on a parent window, its children are disconnected 

from the window tree and are hence removed from the screen. However, any client-side 

resources owned by its children are not freed. To free these resources, Close() 

(or Destroy()) must be called on all its children individually. */

	{

	if (iBuffer && iWsHandle)

		Write(EWsWinOpFree);

	iWsHandle=NULL;

	}

EXPORT_C void RWindowTreeNode::Destroy()

/** Closes and deletes the node. 

This function calls Close() followed by delete on the window. Use this function 

only when the window is allocated in its own heap cell. */

	{

	Close();

	delete this;

	}

EXPORT_C TUint32 RWindowTreeNode::ClientHandle() const

/** Gets the window's client handle

The return value is the client's integer handle that was passed as an argument

to the window's Construct() function: see RWindow::Construct()

for a description of the client handle.

This function always causes a flush of the window server buffer.

@return Handle ID for the window.

@see RWindow::Construct() */

	{

	return(WriteReply(EWsWinOpClientHandle));

	}

EXPORT_C TUint32 RWindowTreeNode::Parent() const

/** Gets the node's parent. 

The return value is the client's integer handle that was passed as an argument 

to the parent window tree node's Construct() function: see RWindow::Construct() 

for a description of the client handle.

If called on a window group, this function returns 0, as window groups have 

no parent.

This function always causes a flush of the window server buffer.

@return Handle ID for the parent, or zero for window groups. 

@see Child() 

@see RWindow::Construct() */

	{

	return(WriteReply(EWsWinOpParent));

	}

EXPORT_C TUint32 RWindowTreeNode::PrevSibling() const

/** Gets the node before this one in the sibling list. 

The return value is the client handle that was passed in the previous sibling window's 

Construct() function: see RWindow::Construct() for a description of the client handle.

This function always causes a flush of the window server buffer.

@return Handle ID for the previous sibling, or zero if no previous sibling exists. 

@see NextSibling() 

@see RWindow::Construct() */

	{

	return(WriteReply(EWsWinOpPrevSibling));

	}

EXPORT_C TUint32 RWindowTreeNode::NextSibling() const

/** Gets the next window after this one in its sibling list. 

The return value is the client handle that was passed in the next sibling 

window's Construct() function: see RWindow::Construct() for a description of the 

client handle.

This function always causes a flush of the window server buffer.

@return Window handle of next sibling, or 0 if no next sibling exists. 

@see PrevSibling()

@see Child()

@see Parent() */

	{

	return(WriteReply(EWsWinOpNextSibling));

	}

EXPORT_C TUint32 RWindowTreeNode::Child() const

/** Gets the first child of the node.

This function always causes a flush of the window server buffer.

@return The client handle of the child node that currently has ordinal position 

0. This is 0 if there isn't a child. */

	{

	return(WriteReply(EWsWinOpChild));

	}

EXPORT_C void RWindowTreeNode::__DbgTestInvariant() const

/** In debug builds, this function always causes a flush of the window 

server buffer. */

	{

#if defined(_DEBUG)

	if (WriteReply(EWsWinOpTestInvariant))

		User::Invariant();

#endif

	}

EXPORT_C void RWindowTreeNode::SetOrdinalPosition(TInt aPos)

/** Sets the ordinal position of a window. 

A window's ordinal position is relative to its siblings with the same 

ordinal priority. The ordinal priority of displayable windows (in other words, 

not window groups) is almost always zero (the default). To set the ordinal priority 

as well as the ordinal position, use the other overload of this function. 

The lower the ordinal position, the nearer the window will be to the front of the z-order. 

The frontmost window has ordinal position zero. Specifying a negative value has the effect 

of sending the window to the back of the z-order.

Note: If this window is a window group in a chain, then all other window groups in the chain will be moved also.

When this function is called on Group Window with aPos set to KOrdinalPositionSwitchToOwningWindow then the 

function doesn't change the ordinal position of the group window, if instead it has focus then the window group 

that would come to the forground if it died will be moved to the foreground.

@param aPos The window's new ordinal position. The lower the ordinal, the closer to the 

front of the z-order the window will be. Specifying any negative value however, sends 

the window to the back of the z-order. */

	{

	WriteInt(aPos,EWsWinOpSetOrdinalPosition);

	}

EXPORT_C void RWindowTreeNode::SetOrdinalPosition(TInt aPos,TInt aOrdinalPriority)

/** Sets the ordinal position and ordinal priority of a window. 

Ordinal priority is a number assigned to a window that determines its position in the z-order. 

For sibling windows or group windows, the higher the priority, the closer it will be to the 

front. Ordinal priority overrides ordinal position, so that the ordinal position 

is only taken into account for sibling windows or window groups with the same ordinal priority. 

For a description of ordinal position, see the other overload of this function.

Most windows have an ordinal priority of zero. Only window groups are normally 

given non-default ordinal priorities.

To set priority of KPasswordWindowGroupPriority or greater on a window group, client will require 

SwEvent capability. If client does not have SwEvent capability then priority will be reduced 

to KPasswordWindowGroupPriority-1. This function doesn't return an error thus the client cannot 

tell if the priority is reduced, however, there is another function that can be used if the client 

does require an error, this is RWindowGroup::SetOrdinalPositionErr.

Note: If this window is a window group in a chain, then all other window groups in the chain will be moved also. 

And further they will all have their ordinal priority set to the specified value.

When this function is called on Group Window with aPos set to KOrdinalPositionSwitchToOwningWindow then the 

function doesn't change the ordinal position of the group window, if instead it has focus then the window group 

that would come to the forground if it died will be moved to the foreground.

@param aPos The window's new ordinal position. The lower the ordinal, the closer to the 

front of the z-order the window will be. Specifying any negative value however, sends 

the window to the back of the z-order.

@param aOrdinalPriority The window's new ordinal priority. */

	{

	TWsWinCmdOrdinalPos ordinalPos;

	ordinalPos.pos=aPos;

	ordinalPos.ordinalPriority=aOrdinalPriority;

	Write(&ordinalPos,sizeof(ordinalPos),EWsWinOpSetOrdinalPositionPri);

	}

EXPORT_C TInt RWindowTreeNode::OrdinalPriority() const

/** Gets the ordinal priority of the specified window.

This function was added for FEPs that need to know the priority in their dialogues. 

This function and RWsSession::GetWindowGroupOrdinalPriority() may return different 

values because this function isn't subject to any ordinal priority adjustment, 

while the window group ordinal priority may be.

This function always causes a flush of the window server buffer.

@return The ordinal priority of the specified window */

	{

	return(WriteReply(EWsWinOpOrdinalPriority));

	}

EXPORT_C TInt RWindowTreeNode::OrdinalPosition() const

/** Gets the current ordinal position of the window tree node. 

The ordinal position returned is the window's position amongst windows with 

the same parent (an with the same priority). Displayable windows almost always 

have the same priority, but window groups might typically have different priorities. 

If a window group's ordinal position among window groups of all priorities 

is required, use FullOrdinalPosition().

Note: all group windows (across all clients) have the same parent.

This function always causes a flush of the window server buffer.

@return The window's ordinal position. */

	{

	return(WriteReply(EWsWinOpOrdinalPosition));

	}

EXPORT_C TInt RWindowTreeNode::FullOrdinalPosition() const

/** Get the current full ordinal position of a window. 

This function normally returns a useful value only when called on a window 

group, because only window groups are normally given different priorities. 

For other types of window the value returned is usually the same as that returned 

by OrdinalPosition().

This function always causes a flush of the window server buffer.

@return The window's full ordinal position. */

	{

	return(WriteReply(EWsWinOpFullOrdinalPosition));

	}

/**Get the screen number that a window is located on

@return The screen number that the window is located on

 */

EXPORT_C TInt RWindowTreeNode::ScreenNumber() const

	{

	return(WriteReply(EWsWinOpScreenNumber));

	}

EXPORT_C TInt RWindowTreeNode::WindowGroupId() const

/** Returns the window group Id of the parent window group

If the window is a window group it will return it's Id. If it is not it scans 

up the window tree to find the group window from which this window is descended 

and returns it's Id.

This function always causes a flush of the window server buffer.

@return The window group Id of the window group from which this window is descended. */

	{

	return(WriteReply(EWsWinOpWindowGroupId));

	}

EXPORT_C TInt RWindowTreeNode::EnableOnEvents(TEventControl aCircumstances)

/** Requests notification of 'on' events. 'On' events are of type EEventSwitchOn.

This function always causes a flush of the window server buffer.

@param aCircumstances The circumstances in which 'on' events are to be reported. 

@return KErrNone if successful, otherwise one of the system-wide error codes. 

@see DisableOnEvents() */

	{

	return(WriteReplyInt(aCircumstances,EWsWinOpEnableOnEvents));

	}

EXPORT_C void RWindowTreeNode::DisableOnEvents()

/** Cancels notification of 'on' events. 

This function instructs the server to stop reporting 'on' events to this window. 

If the window server has not previously been instructed to report 'on' events, 

this method has no effect (i.e. the default is that windows do not get the 

events).

@see EnableOnEvents() */

	{

	if (iWsHandle)

		Write(EWsWinOpDisableOnEvents);

	}

EXPORT_C TInt RWindowTreeNode::EnableGroupChangeEvents()

/** Requests notification of group-change events.

Use this function to instruct the window server to report group-change events 

to this window. These events will typically be of interest to a shell or similar 

application, for example to notify it that it should update its list of running 

applications. Window group changed events are of type EEventWindowGroupsChanged.

This function always causes a flush of the window server buffer.

@return KErrNone if successful, otherwise one of the system-wide error codes. 

@see DisableGroupChangeEvents() */

	{

	return(WriteReply(EWsWinOpEnableGroupChangeEvents));

	}

EXPORT_C void RWindowTreeNode::DisableGroupChangeEvents()

/** Cancels notification of group changed events. 

Use this function to instruct the server to stop reporting window group changed 

events to this window. If the window server has not previously been instructed 

to report window group changed events, this function has no effect (i.e. the 

default is that windows do not get the events).

@see EnableGroupChangeEvents() */

	{

	if (iWsHandle)

		Write(EWsWinOpDisableGroupChangeEvents);

	}

EXPORT_C TInt RWindowTreeNode::EnableFocusChangeEvents()

/** Enables focus changed events.

After this function is called, the EEventFocusGroupChanged event is delivered 

to the window server message queue every time the focus window group changes. 

The handle of the event is set to the client handle of the window that this 

function is called on.

This function always causes a flush of the window server buffer.

@return KErrNone if successful, otherwise another of the system-wide error 

codes. 

@see DisableFocusChangeEvents() */

	{

	return(WriteReply(EWsWinOpEnableFocusChangeEvents));

	}

EXPORT_C void RWindowTreeNode::DisableFocusChangeEvents()

/** Disables delivery of focus changed events.

Use this function to instruct the server to stop reporting window group focus 

changed events to this window. If the window server has not previously been 

instructed to report window group changed events, this function has no effect 

(i.e. the default is that windows do not get the events).

@see EnableFocusChangeEvents() */

	{

	if (iWsHandle)

		Write(EWsWinOpDisableFocusChangeEvents);

	}

EXPORT_C TInt RWindowTreeNode::EnableGroupListChangeEvents()

/** Enables reporting of window group list change events.

The window group list is a list of all window groups and their z-order. Calling 

this function will cause notification events (of type EEventWindowGroupListChanged) 

for any change in the window group list: additions, removals and reorderings.

This function is useful when you need to know about changes to window groups 

beneath the focused one, for instance when the screen is showing windows from 

more than one window group at the same time.

The handle of the event is set to the client handle of the window that this 

function is called on.

This function always causes a flush of the window server buffer.

@return KErrNone if successful, otherwise another of the system-wide error 

codes. */

	{

	return(WriteReply(EWsWinOpEnableGroupListChangeEvents));

	}

EXPORT_C void RWindowTreeNode::DisableGroupListChangeEvents()

/** Disables reporting of window group list change events.

This function instructs the window server to stop sending window group list 

change events to this window. If the window server has not previously been 

instructed to report window group list change events, this function has no 

effect (i.e. the default is that windows do not receive group list change 

events). */

	{

	if (iWsHandle)

		Write(EWsWinOpDisableGroupListChangeEvents);

	}

EXPORT_C TInt RWindowTreeNode::EnableVisibilityChangeEvents()

/** Enables reporting of window visibility change events.

The window visibility is based on whether or not any area of the window can be seen

on the screen.  This can be affected by SetVisible(), but also by other windows in

front of this one, and by the presence of transparent windows which it can be seen

through.  Calling this function will cause notification events (of type

EEventWindowVisibilityChanged) for any change in the window's visibility.