xref: /aoo41x/main/offapi/com/sun/star/frame/status/ItemState.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_status_ItemState_idl__
#define __com_sun_star_frame_status_ItemState_idl__


//=============================================================================

module com {  module sun {  module star {  module frame { module status {

//=============================================================================

/** these constants describe a state of a <type>ItemStatus</type>.

    @see ItemStatus

    @since OOo 2.0
 */
constants ItemState
{
	//-------------------------------------------------------------------------
	/** specifies an unknown state.
	 */
	const short unknown        = 0;

	//-------------------------------------------------------------------------
	/** specifies that the property is currently disabled.
	 */
    const short disabled       = 1;

	//-------------------------------------------------------------------------
	/** specifies that the property is currently read-only.
	 */
    const short read_only      = 2;

	//-------------------------------------------------------------------------
	/** specifies that the property is currently in a don't care state.

        <p>
        This is normally used if a selection provides more than one state
        for a property at the same time.
        </p>
	 */
    const short dont_care      = 16;

	//-------------------------------------------------------------------------
    /** specifies that the property is currently in a default state.
    */
    const short default_value  = 32;

	//-------------------------------------------------------------------------
    /** specifies that the property is currently in a set state.
    */
    const short set            = 64;
};

//=============================================================================

}; }; }; }; };

#endif