userguide/inc/HelpCommon.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Tue, 31 Aug 2010 15:06:12 +0300
branchRCL_3
changeset 44 12f60d9a73b3
permissions -rw-r--r--
Revision: 201031 Kit: 201035

/*
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*
*/

#ifndef HELPCOMMON_H
#define HELPCOMMON_H

#include <Qt>

//const
const int APPPRIORITY = 2001;
// words
const char* const BACKSLASH = "/";
const char* const SPECIALCHAR = "+";
const char* const HASHMARK = "#";
const char* const COLON = ":";
// help content file name
const char* const XHTMLPATH = "resource/xhtml/";
const char* const CONTENTSZIP = "contents.zip";
const char* const INDEXXML = "index.xml";
const char* const KEYWORDXML = "keywords.xml";
const char* const METAXML = "meta.xml";

// path
const char* const PATH_ROOT = "z:/";
const char* const PATH_TRANSLATIONS = "Z:/resource/qt/translations/";

// URL
const char* const URL_HEADER_APP = "app://";
const char* const URL_HEADER_HTTP = "http://";
const char* const URL_HEADER_HTTPS = "https://";
const char* const URL_HEADER_FTP = "ftp://";
const char* const URL_HEADER_LOCAL = "file:///";
const char* const URL_LINK_SUPPORT= "Link to Nokia.com/support";

// text
const char* const TXT_BUTTON_ALL = "txt_common_button_all";
const char* const TXT_BUTTON_FIND = "txt_common_button_find";
const char* const TXT_BUTTON_LINK_SUPPORT = "txt_user_guide_button_link_to_nokiacomsupport";
const char* const TXT_SETLABEL_SEARCH = "txt_user_guide_setlabel_search";
const char* const TXT_SETLABEL_SEARCH_RESULTS = "txt_user_guide_setlabel_search_results";
const char* const TXT_APPLICATIONS = "txt_user_guide_list_applications";
const char* const TXT_COLLAPSE_ALL = "txt_user_guide_opt_collapse_all";
const char* const TXT_EXPAND_ALL = "txt_user_guide_opt_expand_all";

// docml
const char* const QRC_DOCML_BASE = ":/xml/baseView.docml";
const char* const QRC_DOCML_CATEGORY = ":/xml/categoryView.docml";
const char* const QRC_DOCML_KEYWORD = ":/xml/keywordView.docml";
const char* const QRC_DOCML_CONTENTS = ":/xml/contentsView.docml";
const char* const QRC_DOCML_TOOLBAR = ":/xml/toolbar.docml";
const char* const DOCML_VIEW_NAME = "view_help";
const char* const DOCML_ACTION_ALL = "action_all";
const char* const DOCML_ACTION_SEARCH = "action_find";
const char* const DOCML_ACTION_LINK_NOKIA = "action_online_support";
const char* const DOCML_LIST_CATEGORY_ALL = "list_category_all";
const char* const DOCML_LIST_SEARCH = "list_search";
const char* const DOCML_SEARCH_PANEL = "search_panel";
const char* const DOCML_TOOLBAR = "toolbar";
const char* const DOCML_BROWSER_CONTENTS = "browser_contents";
const char* const DOCML_BROWSER = "browser";
const char* const DOCML_LAYOUT_SEARCH = "layout_find";
const char* const DOCML_LAYOUT_SEARCH_NO_SRHPAL = "layout_find_no_searchpanel";
const char* const DOCML_GROUPBOX = "groupBox";
const char* const DOCML_LAYOUT_SEARCH_NO_MATCH = "layout_find_no_match";
const char* const DOCML_LAYOUT_SEARCH_NO_SRHPAL_NO_MATCH = "layout_find_no_searchpanel_no_match";
const char* const DOCML_NO_MATCH_LABEL = "no_match_label";
const char* const DOCML_ACTION_EXPAND_COLLAPSE_ALL = "action_expand_collapse_all";


// enum

enum HelpViewName
{
    HelpViewCategory = 0,
	HelpViewKeyword,
    HelpViewContents,
	PreviousView = 100
};

enum HelpItemRole
{
    UidRole = Qt::UserRole + 1,
	PriorityRole,
	HrefRole,
    KeywordRole
};

#endif //HELPCOMMON_H