svx/source/accessibility/lookupcolorname.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef INCLUDED_SVX_SOURCE_ACCESSIBILITY_LOOKUPCOLORNAME_HXX
  30 #define INCLUDED_SVX_SOURCE_ACCESSIBILITY_LOOKUPCOLORNAME_HXX
  31
  32 #include "sal/config.h"
  33
  34 namespace rtl { class OUString; }
  35
  36 namespace accessibility {
  37
  38 /** This is a color name lookup targeted to be used by the accessibility
  39     <type>DescriptionGenerator</type> class.  It encapsulates a
  40     <type>com.sun.star.drawing.ColorTable</type> and provides an inverse look
  41     up of color names for given numerical color descriptions (the RGB values
  42     encoded as an integer).
  43
  44     <p>The implementation uses as singleton so that the
  45     <type>com.sun.star.drawing.ColorTable</type> object needs to be created
  46     only once.  That singleton instance for now lives until the application
  47     terminates.  However, the color table from which it takes its values may
  48     change during this time.  Reacting to these changes remains a task for the
  49     future.</p>
  50
  51     @param nColor
  52     This integer is the sum of the 8 Bit red value shifted left 16 Bits, the
  53     green value shifted left 8 Bits, and the unshifted blue value.
  54
  55     @return
  56     The returned string is either the color name of the specified color or,
  57     when no name exists, a string of the form "#RRGGBB" with two hexadecimal
  58     digits for each color component.
  59 */
  60 rtl::OUString lookUpColorName(long color);
  61
  62 }
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */