/*************************************************************************
 *
 *  $RCSfile: XRmStatus.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mh $ $Date: 2003/02/12 13:59:18 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2002
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2002 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2002 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_portal_client_XRmStatus_idl__
#define __com_sun_star_portal_client_XRmStatus_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com
{
module sun
{
module star
{
module portal
{
module client
{
/**	Interface to get infos about the client system and to show
	messages on the client
*/
 	
interface XRmStatus : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** Get the rvp version of the client
		@return version of the remote visualization protocol
	*/
	unsigned long	GetRemoteVersion();

	//-------------------------------------------------------------------------
    /** Get the system type of the client.

        @return
        type of client system, see
        <type scope="com::sun::star::portal::client">SystemType</type>.
    */
	unsigned long	GetSystemType();

	//-------------------------------------------------------------------------
	/** Get the charset of the client
		@return the charset of the client system
	*/
	unsigned long	GetSystemCharSet();
	
	//-------------------------------------------------------------------------
	/** Display an error message box on the client
		@param aMsg 	[in]: error message
		@param nCode	[in]: for future use (ignored by client)
	*/
	void			ShowError( [in] string aMsg, [in] unsigned short nCode );

	//-------------------------------------------------------------------------
	/** Display a warning message box on the client
		@param aMsg 	[in]: warning message
		@param nCode	[in]: for future use (ignored by client)
	*/
	void			ShowWarning( [in] string aMsg, [in] unsigned short nCode );

	//-------------------------------------------------------------------------
	/** Display an info message box on the client
		@param aMsg 	[in]: info message
		@param nCode	[in]: for future use (ignored by client)
	*/
	void			ShowInfo( [in] string aMsg, [in] unsigned short nCode );

	//-------------------------------------------------------------------------
	/** Shutdown the client
	*/
	void			Quit();

	//-------------------------------------------------------------------------
	/** Get the client's screen size in pixel
		@param left 	[out]: left border
		@param right 	[out]: right border
		@param top 		[out]: top border
		@param bottom 	[out]: bottom border
	*/
	void			GetWorkArea( [out] short left, [out] short right, [out] short top, [out] short bottom );
	//-------------------------------------------------------------------------
	/** Retrieves the keyboard and mouse button status.
	@param status [out]: the button status as a combination of:
	<BR>MOUSE_LEFT = 0x0001
	<BR>MOUSE_MIDDLE = 0x0002
	<BR>MOUSE_RIGHT = 0x0004
	<BR>KEY_SHIFT = 0x1000
	<BR>KEY_MOD1 = 0x2000
	<BR>KEY_MOD2 = 0x4000
	*/
	void GetCurrentModButtons( [out] unsigned long status );
};

}; // module client
}; // module portal
}; // module star
}; // module sun
}; // module com

#endif
