userguide/inc/HelpCommon.h
branchRCL_3
changeset 18 cbffe13eac63
parent 17 12f60d9a73b3
equal deleted inserted replaced
17:12f60d9a73b3 18:cbffe13eac63
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef HELPCOMMON_H
       
    19 #define HELPCOMMON_H
       
    20 
       
    21 #include <Qt>
       
    22 
       
    23 //const
       
    24 const int APPPRIORITY = 2001;
       
    25 // words
       
    26 const char* const BACKSLASH = "/";
       
    27 const char* const SPECIALCHAR = "+";
       
    28 const char* const HASHMARK = "#";
       
    29 const char* const COLON = ":";
       
    30 // help content file name
       
    31 const char* const XHTMLPATH = "resource/xhtml/";
       
    32 const char* const CONTENTSZIP = "contents.zip";
       
    33 const char* const INDEXXML = "index.xml";
       
    34 const char* const KEYWORDXML = "keywords.xml";
       
    35 const char* const METAXML = "meta.xml";
       
    36 
       
    37 // path
       
    38 const char* const PATH_ROOT = "z:/";
       
    39 const char* const PATH_TRANSLATIONS = "Z:/resource/qt/translations/";
       
    40 
       
    41 // URL
       
    42 const char* const URL_HEADER_APP = "app://";
       
    43 const char* const URL_HEADER_HTTP = "http://";
       
    44 const char* const URL_HEADER_HTTPS = "https://";
       
    45 const char* const URL_HEADER_FTP = "ftp://";
       
    46 const char* const URL_HEADER_LOCAL = "file:///";
       
    47 const char* const URL_LINK_SUPPORT= "Link to Nokia.com/support";
       
    48 
       
    49 // text
       
    50 const char* const TXT_BUTTON_ALL = "txt_common_button_all";
       
    51 const char* const TXT_BUTTON_FIND = "txt_common_button_find";
       
    52 const char* const TXT_BUTTON_LINK_SUPPORT = "txt_user_guide_button_link_to_nokiacomsupport";
       
    53 const char* const TXT_SETLABEL_SEARCH = "txt_user_guide_setlabel_search";
       
    54 const char* const TXT_SETLABEL_SEARCH_RESULTS = "txt_user_guide_setlabel_search_results";
       
    55 const char* const TXT_APPLICATIONS = "txt_user_guide_list_applications";
       
    56 const char* const TXT_COLLAPSE_ALL = "txt_user_guide_opt_collapse_all";
       
    57 const char* const TXT_EXPAND_ALL = "txt_user_guide_opt_expand_all";
       
    58 
       
    59 // docml
       
    60 const char* const QRC_DOCML_BASE = ":/xml/baseView.docml";
       
    61 const char* const QRC_DOCML_CATEGORY = ":/xml/categoryView.docml";
       
    62 const char* const QRC_DOCML_KEYWORD = ":/xml/keywordView.docml";
       
    63 const char* const QRC_DOCML_CONTENTS = ":/xml/contentsView.docml";
       
    64 const char* const QRC_DOCML_TOOLBAR = ":/xml/toolbar.docml";
       
    65 const char* const DOCML_VIEW_NAME = "view_help";
       
    66 const char* const DOCML_ACTION_ALL = "action_all";
       
    67 const char* const DOCML_ACTION_SEARCH = "action_find";
       
    68 const char* const DOCML_ACTION_LINK_NOKIA = "action_online_support";
       
    69 const char* const DOCML_LIST_CATEGORY_ALL = "list_category_all";
       
    70 const char* const DOCML_LIST_SEARCH = "list_search";
       
    71 const char* const DOCML_SEARCH_PANEL = "search_panel";
       
    72 const char* const DOCML_TOOLBAR = "toolbar";
       
    73 const char* const DOCML_BROWSER_CONTENTS = "browser_contents";
       
    74 const char* const DOCML_BROWSER = "browser";
       
    75 const char* const DOCML_LAYOUT_SEARCH = "layout_find";
       
    76 const char* const DOCML_LAYOUT_SEARCH_NO_SRHPAL = "layout_find_no_searchpanel";
       
    77 const char* const DOCML_GROUPBOX = "groupBox";
       
    78 const char* const DOCML_LAYOUT_SEARCH_NO_MATCH = "layout_find_no_match";
       
    79 const char* const DOCML_LAYOUT_SEARCH_NO_SRHPAL_NO_MATCH = "layout_find_no_searchpanel_no_match";
       
    80 const char* const DOCML_NO_MATCH_LABEL = "no_match_label";
       
    81 const char* const DOCML_ACTION_EXPAND_COLLAPSE_ALL = "action_expand_collapse_all";
       
    82 
       
    83 
       
    84 // enum
       
    85 
       
    86 enum HelpViewName
       
    87 {
       
    88     HelpViewCategory = 0,
       
    89 	HelpViewKeyword,
       
    90     HelpViewContents,
       
    91 	PreviousView = 100
       
    92 };
       
    93 
       
    94 enum HelpItemRole
       
    95 {
       
    96     UidRole = Qt::UserRole + 1,
       
    97 	PriorityRole,
       
    98 	HrefRole,
       
    99     KeywordRole
       
   100 };
       
   101 
       
   102 #endif //HELPCOMMON_H
       
   103