/****************************************************************************** * * * * Copyright (C) 1997-2008 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ /* * Arabic translation for Doxygen * * Please send your comments on this translation to moazreyad@yahoo.com * * Note : consider this file as Beta version for testing Arabic output with Doxygen. * * Revision history : * * 6/2006 : Created initial version of Arabic translation. */ #ifndef TRANSLATOR_AR_H #define TRANSLATOR_AR_H class TranslatorArabic : public TranslatorAdapter_1_4_6 { protected: friend class TranslatorAdapterBase; virtual ~TranslatorArabic() {} public: // --- Language control methods ------------------- /*! Used for identification of the language. The identification * should not be translated. It should be replaced by the name * of the language in English using lower-case characters only * (e.g. "czech", "japanese", "russian", etc.). It should be equal to * the identification used in language.cpp. */ virtual QCString idLanguage() { return "arabic"; } /*! Used to get the LaTeX command(s) for the language support. * This method should return string with commands that switch * LaTeX to the desired language. For example *
"\\usepackage[german]{babel}\n"
     *  
* or *
"\\usepackage{polski}\n"
     *  "\\usepackage[latin2]{inputenc}\n"
     *  "\\usepackage[T1]{fontenc}\n"
     *  
* * The English LaTeX does not use such commands. Because of this * the empty string is returned in this implementation. */ virtual QCString latexLanguageSupportCommand() { return ""; } /*! return the language charset. This will be used for the HTML output */ virtual QCString idLanguageCharset() { return "cp1256"; } // --- Language translation methods ------------------- /*! used in the compound documentation before a list of related functions. */ virtual QCString trRelatedFunctions() { return "دوال ذات صلة"; } /*! subscript for the related functions. */ virtual QCString trRelatedSubscript() { return "(لاحظ أن هذه الدوال ليست أعضاء)"; } /*! header that is put before the detailed description of files, classes and namespaces. */ virtual QCString trDetailedDescription() { return "وصف تفصيلي"; } /*! header that is put before the list of typedefs. */ virtual QCString trMemberTypedefDocumentation() { return "توثيق تعريفات النوع الأعضاء"; } /*! header that is put before the list of enumerations. */ virtual QCString trMemberEnumerationDocumentation() { return "توثيق العدديات الأعضاء"; } /*! header that is put before the list of member functions. */ virtual QCString trMemberFunctionDocumentation() { return "توثيق الدوال الأعضاء"; } /*! header that is put before the list of member attributes. */ virtual QCString trMemberDataDocumentation() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "توثيق الحقل"; } else { return "توثيق البيان العضو"; } } /*! this is the text of a link put after brief descriptions. */ virtual QCString trMore() { return "المزيد ..."; } /*! put in the class documentation */ virtual QCString trListOfAllMembers() { return "اعرض كل الأعضاء"; } /*! used as the title of the "list of all members" page of a class */ virtual QCString trMemberList() { return "قائمة الأعضاء"; } /*! this is the first part of a sentence that is followed by a class name */ virtual QCString trThisIsTheListOfAllMembers() { return "هذه فائمة بكل الأعضاء في "; } /*! this is the remainder of the sentence after the class name */ virtual QCString trIncludingInheritedMembers() { return ", متضمنة كل الأعضاء الموروثة"; } /*! this is put at the author sections at the bottom of man pages. * parameter s is name of the project name. */ virtual QCString trGeneratedAutomatically(const char *s) { QCString result="تم تكوينها آليا بواسطة Doxygen"; if (s) result+=(QCString)" لـ "+s; result+=" من ملفات المصدر."; return result; } /*! put after an enum name in the list of all members */ virtual QCString trEnumName() { return "الإسم العددي"; } /*! put after an enum value in the list of all members */ virtual QCString trEnumValue() { return "القيمة العددية"; } /*! put after an undocumented member in the list of all members */ virtual QCString trDefinedIn() { return "معرف في"; } // quick reference sections /*! This is put above each page as a link to the list of all groups of * compounds or files (see the \\group command). */ virtual QCString trModules() { return "مكونات"; } /*! This is put above each page as a link to the class hierarchy */ virtual QCString trClassHierarchy() { return "الشكل الهرمي للفئة"; } /*! This is put above each page as a link to the list of annotated classes */ virtual QCString trCompoundList() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "هياكل البيانات"; } else { return "قائمة الفئات"; } } /*! This is put above each page as a link to the list of documented files */ virtual QCString trFileList() { return "قائمة الملفات"; } /*! This is put above each page as a link to the list of all verbatim headers */ virtual QCString trHeaderFiles() { return "الملفات الرأسية"; } /*! This is put above each page as a link to all members of compounds. */ virtual QCString trCompoundMembers() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "حقول البيانات"; } else { return "أعضاء الفئة"; } } /*! This is put above each page as a link to all members of files. */ virtual QCString trFileMembers() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "العوام"; } else { return "أعضاء الملف"; } } /*! This is put above each page as a link to all related pages. */ virtual QCString trRelatedPages() { return "صفحات ذات صلة"; } /*! This is put above each page as a link to all examples. */ virtual QCString trExamples() { return "أمثلة"; } /*! This is put above each page as a link to the search engine. */ virtual QCString trSearch() { return "بحث"; } /*! This is an introduction to the class hierarchy. */ virtual QCString trClassHierarchyDescription() { return "قائمة التوارث هذه تم ترتيبها أبجديا بصورة تقريبية ، " "ولكن ليس بصورة تامة:"; } /*! This is an introduction to the list with all files. */ virtual QCString trFileListDescription(bool extractAll) { QCString result="هذه قائمة بكل الملفات"; if (!extractAll) result+="الموثقة "; result+="مع وصف مختصر :"; return result; } /*! This is an introduction to the annotated compound list. */ virtual QCString trCompoundListDescription() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "هذه هي هياكل البيانات مع وصف مختصر:"; } else { return "هذه هي الفئات ، البناءات ،" "الإتحادات والواجهات مع وصف مختصر:"; } } /*! This is an introduction to the page with all class members. */ virtual QCString trCompoundMembersDescription(bool extractAll) { QCString result="هذه قائمة بكل "; if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { result+="حقول البناءات والإتحادات"; } else { result+="أعضاء الفئة"; } if (!extractAll) { result+=" الموثقة "; } result+=" مع وصلات إلى "; if (!extractAll) { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { result+="توثيق البناء/الإتحاد لكل حقل:"; } else { result+="توثيق الفئة لكل عضو:"; } } else { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { result+="البناءات/الإتحادات التي ينتمون إليها:"; } else { result+="الفئات التي ينتمون إليها:"; } } return result; } /*! This is an introduction to the page with all file members. */ virtual QCString trFileMembersDescription(bool extractAll) { QCString result="Here is a list of all "; if (!extractAll) result+="documented "; if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { result+="functions, variables, defines, enums, and typedefs"; } else { result+="file members"; } result+=" with links to "; if (extractAll) result+="the files they belong to:"; else result+="the documentation:"; return result; } /*! This is an introduction to the page with the list of all header files. */ virtual QCString trHeaderFilesDescription() { return "Here are the header files that make up the API:"; } /*! This is an introduction to the page with the list of all examples */ virtual QCString trExamplesDescription() { return "هذه قائمة بكل الأمثلة:"; } /*! This is an introduction to the page with the list of related pages */ virtual QCString trRelatedPagesDescription() { return "هذه قائمة بكل صفحات التوثيق ذات الصلة:"; } /*! This is an introduction to the page with the list of class/file groups */ virtual QCString trModulesDescription() { return "هذه قائمة بكل المكونات:"; } /*! This sentences is used in the annotated class/file lists if no brief * description is given. */ virtual QCString trNoDescriptionAvailable() { return "لا يوجد وصف متاح"; } // index titles (the project name is prepended for these) /*! This is used in HTML as the title of index.html. */ virtual QCString trDocumentation() { return "التوثيق"; } /*! This is used in LaTeX as the title of the chapter with the * index of all groups. */ virtual QCString trModuleIndex() { return "فهرس المكونات"; } /*! This is used in LaTeX as the title of the chapter with the * class hierarchy. */ virtual QCString trHierarchicalIndex() { return "الفهرس الهرمي"; } /*! This is used in LaTeX as the title of the chapter with the * annotated compound index. */ virtual QCString trCompoundIndex() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "فهرس هيكل البيانات"; } else { return "فهرس الفئة"; } } /*! This is used in LaTeX as the title of the chapter with the * list of all files. */ virtual QCString trFileIndex() { return "فهرس الملفات"; } /*! This is used in LaTeX as the title of the chapter containing * the documentation of all groups. */ virtual QCString trModuleDocumentation() { return "توثيق المكون"; } /*! This is used in LaTeX as the title of the chapter containing * the documentation of all classes, structs and unions. */ virtual QCString trClassDocumentation() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "فهرس هيكل البيانات"; } else { return "فهرس الفئة"; } } /*! This is used in LaTeX as the title of the chapter containing * the documentation of all files. */ virtual QCString trFileDocumentation() { return "توثيق الملفات"; } /*! This is used in LaTeX as the title of the chapter containing * the documentation of all examples. */ virtual QCString trExampleDocumentation() { return "توثيق الأمثلة"; } /*! This is used in LaTeX as the title of the chapter containing * the documentation of all related pages. */ virtual QCString trPageDocumentation() { return "توثيق الصفحات"; } /*! This is used in LaTeX as the title of the document */ virtual QCString trReferenceManual() { return "الكتيب المرجعي"; } /*! This is used in the documentation of a file as a header before the * list of defines */ virtual QCString trDefines() { return "التعريفات"; } /*! This is used in the documentation of a file as a header before the * list of function prototypes */ virtual QCString trFuncProtos() { return "Function Prototypes"; } /*! This is used in the documentation of a file as a header before the * list of typedefs */ virtual QCString trTypedefs() { return "Typedefs"; } /*! This is used in the documentation of a file as a header before the * list of enumerations */ virtual QCString trEnumerations() { return "العدديات"; } /*! This is used in the documentation of a file as a header before the * list of (global) functions */ virtual QCString trFunctions() { return "الدوال"; } /*! This is used in the documentation of a file as a header before the * list of (global) variables */ virtual QCString trVariables() { return "المتغيرات"; } /*! This is used in the documentation of a file as a header before the * list of (global) variables */ virtual QCString trEnumerationValues() { return "Enumerator"; } /*! This is used in the documentation of a file before the list of * documentation blocks for defines */ virtual QCString trDefineDocumentation() { return "Define Documentation"; } /*! This is used in the documentation of a file/namespace before the list * of documentation blocks for function prototypes */ virtual QCString trFunctionPrototypeDocumentation() { return "Function Prototype Documentation"; } /*! This is used in the documentation of a file/namespace before the list * of documentation blocks for typedefs */ virtual QCString trTypedefDocumentation() { return "Typedef Documentation"; } /*! This is used in the documentation of a file/namespace before the list * of documentation blocks for enumeration types */ virtual QCString trEnumerationTypeDocumentation() { return "Enumeration Type Documentation"; } /*! This is used in the documentation of a file/namespace before the list * of documentation blocks for enumeration values */ virtual QCString trEnumerationValueDocumentation() { return "Enumerator Documentation"; } /*! This is used in the documentation of a file/namespace before the list * of documentation blocks for functions */ virtual QCString trFunctionDocumentation() { return "توثيق الدالة"; } /*! This is used in the documentation of a file/namespace before the list * of documentation blocks for variables */ virtual QCString trVariableDocumentation() { return "توثيق المتغير"; } /*! This is used in the documentation of a file/namespace/group before * the list of links to documented compounds */ virtual QCString trCompounds() { if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { return "هياكل البيانات"; } else { return "الفئات"; } } /*! This is used in the standard footer of each page and indicates when * the page was generated */ virtual QCString trGeneratedAt(const char *date,const char *projName) { QCString result=(QCString)"Generated on "+date; if (projName) result+=(QCString)" for "+projName; result+=(QCString)" by"; return result; } /*! This is part of the sentence used in the standard footer of each page. */ virtual QCString trWrittenBy() { return "كتب بواسطة"; } /*! this text is put before a class diagram */ virtual QCString trClassDiagram(const char *clName) { return (QCString)"Inheritance diagram for "+clName+":"; } /*! this text is generated when the \\internal command is used. */ virtual QCString trForInternalUseOnly() { return "للاستخدام الداخلي فقط."; } /*! this text is generated when the \\reimp command is used. */ virtual QCString trReimplementedForInternalReasons() { return "Reimplemented for internal reasons; the API is not affected."; } /*! this text is generated when the \\warning command is used. */ virtual QCString trWarning() { return "تنبيه"; } /*! this text is generated when the \\bug command is used. */ virtual QCString trBugsAndLimitations() { return "Bugs and limitations"; } /*! this text is generated when the \\version command is used. */ virtual QCString trVersion() { return "إصدارة"; } /*! this text is generated when the \\date command is used. */ virtual QCString trDate() { return "تاريخ"; } /*! this text is generated when the \\return command is used. */ virtual QCString trReturns() { return "Returns"; } /*! this text is generated when the \\sa command is used. */ virtual QCString trSeeAlso() { return "انظر أيضا"; } /*! this text is generated when the \\param command is used. */ virtual QCString trParameters() { return "Parameters"; } /*! this text is generated when the \\exception command is used. */ virtual QCString trExceptions() { return "استثناءات"; } /*! this text is used in the title page of a LaTeX document. */ virtual QCString trGeneratedBy() { return "انتجت بواسطة"; } ////////////////////////////////////////////////////////////////////////// // new since 0.49-990307 ////////////////////////////////////////////////////////////////////////// /*! used as the title of page containing all the index of all namespaces. */ virtual QCString trNamespaceList() { return "قائمة مجالات الأسماء"; } /*! used as an introduction to the namespace list */ virtual QCString trNamespaceListDescription(bool extractAll) { QCString result="Here is a list of all "; if (!extractAll) result+="documented "; result+="namespaces with brief descriptions:"; return result; } /*! used in the class documentation as a header before the list of all * friends of a class */ virtual QCString trFriends() { return "Friends"; } ////////////////////////////////////////////////////////////////////////// // new since 0.49-990405 ////////////////////////////////////////////////////////////////////////// /*! used in the class documentation as a header before the list of all * related classes */ virtual QCString trRelatedFunctionDocumentation() { return "Friends And Related Function Documentation"; } ////////////////////////////////////////////////////////////////////////// // new since 0.49-990425 ////////////////////////////////////////////////////////////////////////// /*! used as the title of the HTML page of a class/struct/union */ virtual QCString trCompoundReference(const char *clName, ClassDef::CompoundType compType, bool isTemplate) { QCString result=(QCString)clName; switch(compType) { case ClassDef::Class: result+=" Class"; break; case ClassDef::Struct: result+=" Struct"; break; case ClassDef::Union: result+=" Union"; break; case ClassDef::Interface: result+=" Interface"; break; case ClassDef::Protocol: result+=" Protocol"; break; case ClassDef::Category: result+=" Category"; break; case ClassDef::Exception: result+=" Exception"; break; } if (isTemplate) result+=" Template"; result+=" Reference"; return result; } /*! used as the title of the HTML page of a file */ virtual QCString trFileReference(const char *fileName) { QCString result=fileName; result+=" File Reference"; return result; } /*! used as the title of the HTML page of a namespace */ virtual QCString trNamespaceReference(const char *namespaceName) { QCString result=namespaceName; result+=" Namespace Reference"; return result; } virtual QCString trPublicMembers() { return "Public Member Functions"; } virtual QCString trPublicSlots() { return "Public Slots"; } virtual QCString trSignals() { return "Signals"; } virtual QCString trStaticPublicMembers() { return "Static Public Member Functions"; } virtual QCString trProtectedMembers() { return "Protected Member Functions"; } virtual QCString trProtectedSlots() { return "Protected Slots"; } virtual QCString trStaticProtectedMembers() { return "Static Protected Member Functions"; } virtual QCString trPrivateMembers() { return "Private Member Functions"; } virtual QCString trPrivateSlots() { return "Private Slots"; } virtual QCString trStaticPrivateMembers() { return "Static Private Member Functions"; } /*! this function is used to produce a comma-separated list of items. * use generateMarker(i) to indicate where item i should be put. */ virtual QCString trWriteList(int numEntries) { QCString result; int i; // the inherits list contain `numEntries' classes for (i=0;i