kstandardshortcut.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1997 Stefan Taferner (taferner@kde.org)
    Copyright (C) 2000 Nicolas Hadacek (hadacek@kde.org)
    Copyright (C) 2001,2002 Ellis Whitehead (ellis@kde.org)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef KSTANDARDSHORTCUT_H
#define KSTANDARDSHORTCUT_H

#include <QtCore/QString>

#include "kshortcut.h"


namespace KStandardShortcut
{ // STUFF WILL BREAK IF YOU DON'T READ THIS!!!
  /*
   *Always add new std-accels to the end of this enum, never in the middle!
   *Don't forget to add the corresponding entries in g_infoStandardShortcut[] in kstandardshortcut.cpp, too.
   *Values of elements here and positions of the corresponding entries in
   *the big array g_infoStandardShortcut[] ABSOLUTELY MUST BE THE SAME.
   * !!!    !!!!   !!!!!    !!!!
   *    !!!!    !!!     !!!!    !!!!
   * Remember to also update kdoctools/genshortcutents.cpp.
   *
   * Other Rules:
   *
   * - Never change the name of an existing shortcut
   * - Never translate the name of a shortcut
   */

  enum StandardShortcut {
    //C++ requires that the value of an enum symbol be one more than the previous one.
    //This means that everything will be well-ordered from here on.
    AccelNone=0,
    // File menu
    Open, New, Close, Save,
    // The Print item
    Print,
    Quit,
    // Edit menu
    Undo, Redo, Cut, Copy, Paste,     PasteSelection,
    SelectAll, Deselect, DeleteWordBack, DeleteWordForward,
    Find, FindNext, FindPrev, Replace,
    // Navigation
    Home, Begin, End, Prior, Next,
    Up, Back, Forward, Reload,
    // Text Navigation
    BeginningOfLine, EndOfLine, GotoLine,
    BackwardWord, ForwardWord,
    // View parameters
    AddBookmark, ZoomIn, ZoomOut, FullScreen,
    ShowMenubar,
    // Tabular navigation
    TabNext, TabPrev,
    // Help menu
    Help, WhatsThis,
    // Text completion
    TextCompletion, PrevCompletion, NextCompletion, SubstringCompletion,

    RotateUp, RotateDown,

    OpenRecent,
    SaveAs,
    Revert,
    PrintPreview,
    Mail,
    Clear,
    ActualSize,
    FitToPage,
    FitToWidth,
    FitToHeight,
    Zoom,
    Goto,
    GotoPage,
    DocumentBack,
    DocumentForward,
    EditBookmarks,
    Spelling,
    ShowToolbar,
    ShowStatusbar,
    SaveOptions,
    KeyBindings,
    Preferences,
    ConfigureToolbars,
    ConfigureNotifications,
    TipofDay,
    ReportBug,
    SwitchApplicationLanguage,
    AboutApp,
    AboutKDE,

    // Insert new items here!

    StandardShortcutCount // number of standard shortcuts
  };

  KDEUI_EXPORT const KShortcut &shortcut(StandardShortcut id);

  KDEUI_EXPORT QString name(StandardShortcut id);

  KDEUI_EXPORT QString label(StandardShortcut id);

  KDEUI_EXPORT QString whatsThis(StandardShortcut id);

  KDEUI_EXPORT StandardShortcut find(const QKeySequence &keySeq);

  KDEUI_EXPORT StandardShortcut find(const char *keyName);

  KDEUI_EXPORT KShortcut hardcodedDefaultShortcut(StandardShortcut id);

  KDEUI_EXPORT void saveShortcut(StandardShortcut id, const KShortcut &newShortcut);

  KDEUI_EXPORT const KShortcut &open();

  KDEUI_EXPORT const KShortcut &openNew();

  KDEUI_EXPORT const KShortcut &close();

  KDEUI_EXPORT const KShortcut &save();

  KDEUI_EXPORT const KShortcut &print();

  KDEUI_EXPORT const KShortcut &quit();

  KDEUI_EXPORT const KShortcut &undo();

  KDEUI_EXPORT const KShortcut &redo();

  KDEUI_EXPORT const KShortcut &cut();

  KDEUI_EXPORT const KShortcut &copy();

  KDEUI_EXPORT const KShortcut &paste();

  KDEUI_EXPORT const KShortcut &pasteSelection();

  KDEUI_EXPORT const KShortcut &selectAll();

  KDEUI_EXPORT const KShortcut &deleteWordBack();

  KDEUI_EXPORT const KShortcut &deleteWordForward();

  KDEUI_EXPORT const KShortcut &find();

  KDEUI_EXPORT const KShortcut &findNext();

  KDEUI_EXPORT const KShortcut &findPrev();

  KDEUI_EXPORT const KShortcut &replace();

  KDEUI_EXPORT const KShortcut &zoomIn();

  KDEUI_EXPORT const KShortcut &zoomOut();

  KDEUI_EXPORT const KShortcut &insert();

  KDEUI_EXPORT const KShortcut &home();

  KDEUI_EXPORT const KShortcut &begin();

  KDEUI_EXPORT const KShortcut &end();

  KDEUI_EXPORT const KShortcut &beginningOfLine();

  KDEUI_EXPORT const KShortcut &endOfLine();

  KDEUI_EXPORT const KShortcut &prior();

  KDEUI_EXPORT const KShortcut &next();

  KDEUI_EXPORT const KShortcut &gotoLine();

  KDEUI_EXPORT const KShortcut &addBookmark();

  KDEUI_EXPORT const KShortcut &tabNext();

  KDEUI_EXPORT const KShortcut &tabPrev();

  KDEUI_EXPORT const KShortcut &fullScreen();

  KDEUI_EXPORT const KShortcut &help();

  KDEUI_EXPORT const KShortcut &completion();

  KDEUI_EXPORT const KShortcut &prevCompletion();

  KDEUI_EXPORT const KShortcut &nextCompletion();

  KDEUI_EXPORT const KShortcut &substringCompletion();

  KDEUI_EXPORT const KShortcut &rotateUp();

  KDEUI_EXPORT const KShortcut &rotateDown();

  KDEUI_EXPORT const KShortcut &whatsThis();

  KDEUI_EXPORT const KShortcut &reload();

  KDEUI_EXPORT const KShortcut &up();

  KDEUI_EXPORT const KShortcut &back();

  KDEUI_EXPORT const KShortcut &forward();

  KDEUI_EXPORT const KShortcut &backwardWord();

  KDEUI_EXPORT const KShortcut &forwardWord();

  KDEUI_EXPORT const KShortcut &showMenubar();

}

#endif // KSTANDARDSHORTCUT_H