kdecore/localization/common_helpers_p.h

   1 /*  This file is part of the KDE libraries
   2     Copyright (C) 2008 Chusslove Illich <caslav.ilic@gmx.net>
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Library General Public
   6     License as published by the Free Software Foundation; either
   7     version 2 of the License, or (at your option) any later version.
   8
   9     This library is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     Library General Public License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to
  16     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17     Boston, MA 02110-1301, USA.
  18 */
  19
  20 #ifndef COMMON_HELPERS_P_H
  21 #define COMMON_HELPERS_P_H
  22
  23 #include <QString>
  24
  25 // Standalone (pure Qt) functionality needed internally in more than
  26 // one source file on localization.
  27
  28 /**
  29   * @internal
  30   *
  31   * Removes accelerator marker from a UI text label.
  32   *
  33   * Accelerator marker is not always a plain ampersand (&),
  34   * so it is not enough to just remove it by @c QString::remove().
  35   * The label may contain escaped markers ("&&") which must be resolved
  36   * and skipped, as well as CJK-style markers ("Foo (&F)") where
  37   * the whole parenthesis construct should be removed.
  38   * Therefore always use this function to remove accelerator marker
  39   * from UI labels.
  40   *
  41   * @param label UI label which may contain an accelerator marker
  42   * @return label without the accelerator marker
  43   */
  44 QString removeAcceleratorMarker (const QString &label);
  45
  46 #endif