translator_ar.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  *
00003  * 
00004  *
00005  * Copyright (C) 1997-2008 by Dimitri van Heesch.
00006  *
00007  * Permission to use, copy, modify, and distribute this software and its
00008  * documentation under the terms of the GNU General Public License is hereby 
00009  * granted. No representations are made about the suitability of this software 
00010  * for any purpose. It is provided "as is" without express or implied warranty.
00011  * See the GNU General Public License for more details.
00012  *
00013  * Documents produced by Doxygen are derivative works derived from the
00014  * input used in their production; they are not affected by this license.
00015  *
00016  */
00017 
00018 /*
00019  * Arabic translation for Doxygen
00020  *
00021  * Please send your comments on this translation to moazreyad@yahoo.com
00022  *
00023  * Note : consider this file as Beta version for testing Arabic output with Doxygen.
00024  * 
00025  * Revision history :
00026  *
00027  * 6/2006 : Created initial version of Arabic translation.
00028  */
00029 
00030 #ifndef TRANSLATOR_AR_H
00031 #define TRANSLATOR_AR_H
00032 
00033 class TranslatorArabic : public TranslatorAdapter_1_4_6
00034 {
00035   protected:
00036     friend class TranslatorAdapterBase;
00037     virtual ~TranslatorArabic() {}
00038 
00039   public:
00040 
00041     // --- Language control methods -------------------
00042     
00049     virtual QCString idLanguage()
00050     { return "arabic"; }
00051     
00066     virtual QCString latexLanguageSupportCommand()
00067     {
00068       return "";
00069     }
00070 
00072     virtual QCString idLanguageCharset()
00073     {
00074       return "cp1256";
00075     }
00076 
00077     // --- Language translation methods -------------------
00078 
00080     virtual QCString trRelatedFunctions()
00081     { return "دوال ذات صلة"; }
00082 
00084     virtual QCString trRelatedSubscript()
00085     { return "(لاحظ أن هذه الدوال ليست أعضاء)"; }
00086 
00088     virtual QCString trDetailedDescription()
00089     { return "وصف تفصيلي"; }
00090 
00092     virtual QCString trMemberTypedefDocumentation()
00093     { return "توثيق تعريفات النوع الأعضاء"; }
00094     
00096     virtual QCString trMemberEnumerationDocumentation()
00097     { return "توثيق العدديات الأعضاء"; }
00098     
00100     virtual QCString trMemberFunctionDocumentation()
00101     { return "توثيق الدوال الأعضاء"; }
00102     
00104     virtual QCString trMemberDataDocumentation()
00105     { 
00106       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00107       {
00108         return "توثيق الحقل"; 
00109       }
00110       else
00111       {
00112         return "توثيق البيان العضو"; 
00113       }
00114     }
00115 
00117     virtual QCString trMore() 
00118     { return "المزيد ..."; }
00119 
00121     virtual QCString trListOfAllMembers()
00122     { return "اعرض كل الأعضاء"; }
00123 
00125     virtual QCString trMemberList()
00126     { return "قائمة الأعضاء"; }
00127 
00129     virtual QCString trThisIsTheListOfAllMembers()
00130     { return "هذه فائمة بكل الأعضاء في "; }
00131 
00133     virtual QCString trIncludingInheritedMembers()
00134     { return ", متضمنة كل الأعضاء الموروثة"; }
00135     
00139     virtual QCString trGeneratedAutomatically(const char *s)
00140     { QCString result="تم تكوينها آليا بواسطة Doxygen";
00141       if (s) result+=(QCString)" لـ "+s;
00142       result+=" من ملفات المصدر."; 
00143       return result;
00144     }
00145 
00147     virtual QCString trEnumName()
00148     { return "الإسم العددي"; }
00149     
00151     virtual QCString trEnumValue()
00152     { return "القيمة العددية"; }
00153     
00155     virtual QCString trDefinedIn()
00156     { return "معرف في"; }
00157 
00158     // quick reference sections
00159 
00163     virtual QCString trModules()
00164     { return "مكونات"; }
00165     
00167     virtual QCString trClassHierarchy()
00168     { return "الشكل الهرمي للفئة"; }
00169     
00171     virtual QCString trCompoundList()
00172     { 
00173       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00174       {
00175         return "هياكل البيانات";
00176       }
00177       else
00178       {
00179         return "قائمة الفئات"; 
00180       }
00181     }
00182     
00184     virtual QCString trFileList()
00185     { return "قائمة الملفات"; }
00186 
00188     virtual QCString trHeaderFiles()
00189     { return "الملفات الرأسية"; }
00190 
00192     virtual QCString trCompoundMembers()
00193     { 
00194       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00195       {
00196         return "حقول البيانات"; 
00197       }
00198       else
00199       {
00200         return "أعضاء الفئة"; 
00201       }
00202     }
00203 
00205     virtual QCString trFileMembers()
00206     { 
00207       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00208       {
00209         return "العوام"; 
00210       }
00211       else
00212       {
00213         return "أعضاء الملف"; 
00214       }
00215     }
00216 
00218     virtual QCString trRelatedPages()
00219     { return "صفحات ذات صلة"; }
00220 
00222     virtual QCString trExamples()
00223     { return "أمثلة"; }
00224 
00226     virtual QCString trSearch()
00227     { return "بحث"; }
00228 
00230     virtual QCString trClassHierarchyDescription()
00231     { return "قائمة التوارث هذه تم ترتيبها أبجديا بصورة تقريبية ، "
00232              "ولكن ليس بصورة تامة:";
00233     }
00234 
00236     virtual QCString trFileListDescription(bool extractAll)
00237     {
00238       QCString result="هذه قائمة بكل الملفات";
00239       if (!extractAll) result+="الموثقة ";
00240           result+="مع وصف مختصر :";
00241       return result;
00242     }
00243 
00245     virtual QCString trCompoundListDescription()
00246     { 
00247       
00248       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00249       {
00250         return "هذه هي هياكل البيانات مع وصف مختصر:"; 
00251       }
00252       else
00253       {
00254         return "هذه هي الفئات ، البناءات ،"
00255                         "الإتحادات والواجهات مع وصف مختصر:"; 
00256       }
00257     }
00258 
00260     virtual QCString trCompoundMembersDescription(bool extractAll)
00261     {
00262       QCString result="هذه قائمة بكل ";
00263       
00264       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00265       {
00266         result+="حقول البناءات والإتحادات";
00267       }
00268       else
00269       {
00270         result+="أعضاء الفئة";
00271       }
00272           if (!extractAll)
00273       {
00274         result+=" الموثقة ";
00275       }
00276       result+=" مع وصلات إلى ";
00277       if (!extractAll) 
00278       {
00279         if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00280         {
00281           result+="توثيق البناء/الإتحاد لكل حقل:";
00282         }
00283         else
00284         {
00285           result+="توثيق الفئة لكل عضو:";
00286         }
00287       }
00288       else 
00289       {
00290         if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00291         {
00292           result+="البناءات/الإتحادات التي ينتمون إليها:";
00293         }
00294         else
00295         {
00296           result+="الفئات التي ينتمون إليها:";
00297         }
00298       }
00299       return result;
00300     }
00301 
00303     virtual QCString trFileMembersDescription(bool extractAll)
00304     {
00305       QCString result="Here is a list of all ";
00306       if (!extractAll) result+="documented ";
00307       
00308       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00309       {
00310         result+="functions, variables, defines, enums, and typedefs";
00311       }
00312       else
00313       {
00314         result+="file members";
00315       }
00316       result+=" with links to ";
00317       if (extractAll) 
00318         result+="the files they belong to:";
00319       else 
00320         result+="the documentation:";
00321       return result;
00322     }
00323 
00325     virtual QCString trHeaderFilesDescription()
00326     { return "Here are the header files that make up the API:"; }
00327 
00329     virtual QCString trExamplesDescription()
00330     { return "هذه قائمة بكل الأمثلة:"; }
00331 
00333     virtual QCString trRelatedPagesDescription()
00334     { return "هذه قائمة بكل صفحات التوثيق ذات الصلة:"; }
00335 
00337     virtual QCString trModulesDescription()
00338     { return "هذه قائمة بكل المكونات:"; }
00339 
00343     virtual QCString trNoDescriptionAvailable()
00344     { return "لا يوجد وصف متاح"; }
00345     
00346     // index titles (the project name is prepended for these) 
00347 
00348 
00350     virtual QCString trDocumentation()
00351     { return "التوثيق"; }
00352 
00356     virtual QCString trModuleIndex()
00357     { return "فهرس المكونات"; }
00358 
00362     virtual QCString trHierarchicalIndex()
00363     { return "الفهرس الهرمي"; }
00364 
00368     virtual QCString trCompoundIndex()
00369     {
00370       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00371       { 
00372         return "فهرس هيكل البيانات";
00373       }
00374       else
00375       {
00376         return "فهرس الفئة"; 
00377       }
00378     }
00379 
00383     virtual QCString trFileIndex() 
00384     { return "فهرس الملفات"; }
00385 
00389     virtual QCString trModuleDocumentation()
00390     { return "توثيق المكون"; }
00391 
00395     virtual QCString trClassDocumentation()
00396     { 
00397       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00398       {
00399         return "فهرس هيكل البيانات"; 
00400       }
00401       else
00402       {
00403         return "فهرس الفئة"; 
00404       }
00405     }
00406 
00410     virtual QCString trFileDocumentation()
00411     { return "توثيق الملفات"; }
00412 
00416     virtual QCString trExampleDocumentation()
00417     { return "توثيق الأمثلة"; }
00418 
00422     virtual QCString trPageDocumentation()
00423     { return "توثيق الصفحات"; }
00424 
00426     virtual QCString trReferenceManual()
00427     { return "الكتيب المرجعي"; }
00428     
00432     virtual QCString trDefines()
00433     { return "التعريفات"; }
00434 
00438     virtual QCString trFuncProtos()
00439     { return "Function Prototypes"; }
00440 
00444     virtual QCString trTypedefs()
00445     { return "Typedefs"; }
00446 
00450     virtual QCString trEnumerations()
00451     { return "العدديات"; }
00452 
00456     virtual QCString trFunctions()
00457     { return "الدوال"; }
00458 
00462     virtual QCString trVariables()
00463     { return "المتغيرات"; }
00464 
00468     virtual QCString trEnumerationValues()
00469     { return "Enumerator"; }
00470     
00474     virtual QCString trDefineDocumentation()
00475     { return "Define Documentation"; }
00476 
00480     virtual QCString trFunctionPrototypeDocumentation()
00481     { return "Function Prototype Documentation"; }
00482 
00486     virtual QCString trTypedefDocumentation()
00487     { return "Typedef Documentation"; }
00488 
00492     virtual QCString trEnumerationTypeDocumentation()
00493     { return "Enumeration Type Documentation"; }
00494 
00498     virtual QCString trEnumerationValueDocumentation()
00499     { return "Enumerator Documentation"; }
00500 
00504     virtual QCString trFunctionDocumentation()
00505     { return "توثيق الدالة"; }
00506 
00510     virtual QCString trVariableDocumentation()
00511     { return "توثيق المتغير"; }
00512 
00516     virtual QCString trCompounds()
00517     { 
00518       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00519       {
00520         return "هياكل البيانات"; 
00521       }
00522       else
00523       {
00524         return "الفئات"; 
00525       }
00526     }
00527 
00531     virtual QCString trGeneratedAt(const char *date,const char *projName)
00532     { 
00533       QCString result=(QCString)"Generated on "+date;
00534       if (projName) result+=(QCString)" for "+projName;
00535       result+=(QCString)" by";
00536       return result;
00537     }
00540     virtual QCString trWrittenBy()
00541     {
00542       return "كتب بواسطة";
00543     }
00544 
00546     virtual QCString trClassDiagram(const char *clName)
00547     {
00548       return (QCString)"Inheritance diagram for "+clName+":";
00549     }
00550     
00552     virtual QCString trForInternalUseOnly()
00553     { return "للاستخدام الداخلي فقط."; }
00554 
00556     virtual QCString trReimplementedForInternalReasons()
00557     { return "Reimplemented for internal reasons; the API is not affected."; }
00558 
00560     virtual QCString trWarning()
00561     { return "تنبيه"; }
00562 
00564     virtual QCString trBugsAndLimitations()
00565     { return "Bugs and limitations"; }
00566 
00568     virtual QCString trVersion()
00569     { return "إصدارة"; }
00570 
00572     virtual QCString trDate()
00573     { return "تاريخ"; }
00574 
00576     virtual QCString trReturns()
00577     { return "Returns"; }
00578 
00580     virtual QCString trSeeAlso()
00581     { return "انظر أيضا"; }
00582 
00584     virtual QCString trParameters()
00585     { return "Parameters"; }
00586 
00588     virtual QCString trExceptions()
00589     { return "استثناءات"; }
00590     
00592     virtual QCString trGeneratedBy()
00593     { return "انتجت بواسطة"; }
00594 
00596 // new since 0.49-990307
00598     
00600     virtual QCString trNamespaceList()
00601     { return "قائمة مجالات الأسماء"; }
00602 
00604     virtual QCString trNamespaceListDescription(bool extractAll)
00605     {
00606       QCString result="Here is a list of all ";
00607       if (!extractAll) result+="documented ";
00608       result+="namespaces with brief descriptions:";
00609       return result;
00610     }
00611 
00615     virtual QCString trFriends()
00616     { return "Friends"; }
00617     
00619 // new since 0.49-990405
00621     
00625     virtual QCString trRelatedFunctionDocumentation()
00626     { return "Friends And Related Function Documentation"; }
00627     
00629 // new since 0.49-990425
00631 
00633     virtual QCString trCompoundReference(const char *clName,
00634                                     ClassDef::CompoundType compType,
00635                                     bool isTemplate)
00636     {
00637       QCString result=(QCString)clName;
00638       switch(compType)
00639       {
00640         case ClassDef::Class:      result+=" Class"; break;
00641         case ClassDef::Struct:     result+=" Struct"; break;
00642         case ClassDef::Union:      result+=" Union"; break;
00643         case ClassDef::Interface:  result+=" Interface"; break;
00644         case ClassDef::Protocol:   result+=" Protocol"; break;
00645         case ClassDef::Category:   result+=" Category"; break;
00646         case ClassDef::Exception:  result+=" Exception"; break;
00647       }
00648       if (isTemplate) result+=" Template";
00649       result+=" Reference";
00650       return result;
00651     }
00652 
00654     virtual QCString trFileReference(const char *fileName)
00655     {
00656       QCString result=fileName;
00657       result+=" File Reference"; 
00658       return result;
00659     }
00660 
00662     virtual QCString trNamespaceReference(const char *namespaceName)
00663     {
00664       QCString result=namespaceName;
00665       result+=" Namespace Reference";
00666       return result;
00667     }
00668     
00669     virtual QCString trPublicMembers()
00670     { return "Public Member Functions"; }
00671     virtual QCString trPublicSlots()
00672     { return "Public Slots"; }
00673     virtual QCString trSignals()
00674     { return "Signals"; }
00675     virtual QCString trStaticPublicMembers()
00676     { return "Static Public Member Functions"; }
00677     virtual QCString trProtectedMembers()
00678     { return "Protected Member Functions"; }
00679     virtual QCString trProtectedSlots()
00680     { return "Protected Slots"; }
00681     virtual QCString trStaticProtectedMembers()
00682     { return "Static Protected Member Functions"; }
00683     virtual QCString trPrivateMembers()
00684     { return "Private Member Functions"; }
00685     virtual QCString trPrivateSlots()
00686     { return "Private Slots"; }
00687     virtual QCString trStaticPrivateMembers()
00688     { return "Static Private Member Functions"; }
00689     
00693     virtual QCString trWriteList(int numEntries)
00694     {
00695       QCString result;
00696       int i;
00697       // the inherits list contain `numEntries' classes
00698       for (i=0;i<numEntries;i++) 
00699       {
00700         // use generateMarker to generate placeholders for the class links!
00701         result+=generateMarker(i); // generate marker for entry i in the list 
00702                                    // (order is left to right)
00703         
00704         if (i!=numEntries-1)  // not the last entry, so we need a separator
00705         {
00706           if (i<numEntries-2) // not the fore last entry 
00707             result+=", ";
00708           else                // the fore last entry
00709             result+=", and ";
00710         }
00711       }
00712       return result; 
00713     }
00714     
00718     virtual QCString trInheritsList(int numEntries)
00719     {
00720       return "Inherits "+trWriteList(numEntries)+".";
00721     }
00722 
00726     virtual QCString trInheritedByList(int numEntries)
00727     {
00728       return "Inherited by "+trWriteList(numEntries)+".";
00729     }
00730 
00734     virtual QCString trReimplementedFromList(int numEntries)
00735     {
00736       return "Reimplemented from "+trWriteList(numEntries)+".";
00737     }
00738 
00742     virtual QCString trReimplementedInList(int numEntries)
00743     {
00744       return "Reimplemented in "+trWriteList(numEntries)+".";
00745     }
00746 
00748     virtual QCString trNamespaceMembers()
00749     { return "Namespace Members"; }
00750 
00752     virtual QCString trNamespaceMemberDescription(bool extractAll)
00753     { 
00754       QCString result="Here is a list of all ";
00755       if (!extractAll) result+="documented ";
00756       result+="namespace members with links to ";
00757       if (extractAll) 
00758         result+="the namespace documentation for each member:";
00759       else 
00760         result+="the namespaces they belong to:";
00761       return result;
00762     }
00766     virtual QCString trNamespaceIndex()
00767     { return "فهرس مجالات الأسماء"; }
00768 
00772     virtual QCString trNamespaceDocumentation()
00773     { return "توثيق مجالات الأسماء"; }
00774 
00776 // new since 0.49-990522
00778 
00782     virtual QCString trNamespaces()
00783     { return "مجالات الأسماء"; }
00784 
00786 // new since 0.49-990728
00788 
00792     virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType,
00793         bool single)
00794     { // here s is one of " Class", " Struct" or " Union"
00795       // single is true implies a single file
00796       QCString result=(QCString)"توثيق   ";
00797       switch(compType)
00798       {
00799         case ClassDef::Class:      result+="هذه الفئة"; break;
00800         case ClassDef::Struct:     result+="هذا البناء"; break;
00801         case ClassDef::Union:      result+="هذا الإتحاد"; break;
00802         case ClassDef::Interface:  result+="هذه الواجهة"; break;
00803         case ClassDef::Protocol:   result+="هذا البروتوكول"; break;
00804         case ClassDef::Category:   result+="هذا التصنيف"; break;
00805         case ClassDef::Exception:  result+="هذا الإستثناء"; break;
00806       }
00807       result+=" تم تكوينه من ";
00808           if (single) result+="هذا الملف:"; else result+="هذه الملفات:";
00809       return result;
00810     }
00811 
00815     virtual QCString trAlphabeticalList()
00816     { return "قائمة أبجدية"; }
00817 
00819 // new since 0.49-990901
00821 
00823     virtual QCString trReturnValues()
00824     { return "قيم العودة"; }
00825 
00828     virtual QCString trMainPage()
00829     { return "الصفحة الرئيسية"; }
00830 
00834     virtual QCString trPageAbbreviation()
00835     { return "ص."; }
00836 
00838 // new since 0.49-991003
00840 
00841     virtual QCString trSources()
00842     {
00843       return "مصادر";
00844     }
00845     virtual QCString trDefinedAtLineInSourceFile()
00846     {
00847       return "Definition at line @0 of file @1.";
00848     }
00849     virtual QCString trDefinedInSourceFile()
00850     {
00851       return "Definition in file @0.";
00852     }
00853 
00855 // new since 0.49-991205
00857 
00858     virtual QCString trDeprecated()
00859     {
00860       return "Deprecated";
00861     }
00862 
00864 // new since 1.0.0
00866 
00868     virtual QCString trCollaborationDiagram(const char *clName)
00869     {
00870       return (QCString)"رسم التعاون لـ "+clName+":";
00871     }
00873     virtual QCString trInclDepGraph(const char *fName)
00874     {
00875       return (QCString)"رسم اعتمادية التضمين لـ "+fName+":";
00876     }
00878     virtual QCString trConstructorDocumentation()
00879     {
00880       return "توثيق دوال البناء والهدم"; 
00881     }
00883     virtual QCString trGotoSourceCode()
00884     {
00885       return "اذهب إلى الكود الخاص بهذا الملف.";
00886     }
00888     virtual QCString trGotoDocumentation()
00889     {
00890       return "اذهب إلى توثيق هذا الملف.";
00891     }
00893     virtual QCString trPrecondition()
00894     {
00895       return "شرط سابق";
00896     }
00898     virtual QCString trPostcondition()
00899     {
00900       return "شرط لاحق";
00901     }
00903     virtual QCString trInvariant()
00904     {
00905       return "ثابت";
00906     }
00908     virtual QCString trInitialValue()
00909     {
00910                 return "قيمة مبدئية:";
00911     }
00913     virtual QCString trCode()
00914     {
00915       return "كود";
00916     }
00917     virtual QCString trGraphicalHierarchy()
00918     {
00919       return "الشكل الرسومي للفئات";
00920     }
00921     virtual QCString trGotoGraphicalHierarchy()
00922     {
00923       return "اذهب إلى الشكل الهرمي الرسومي للفئات";
00924     }
00925     virtual QCString trGotoTextualHierarchy()
00926     {
00927       return "اذهب إلى الشكل الهرمي النصي للفئات";
00928     }
00929     virtual QCString trPageIndex()
00930     {
00931       return "فهرس الصفحات";
00932     }
00933 
00935 // new since 1.1.0
00937     
00938     virtual QCString trNote()
00939     {
00940       return "ملاحظات";
00941     }
00942     virtual QCString trPublicTypes()
00943     {
00944       return "أنواع عامة";
00945     }
00946     virtual QCString trPublicAttribs()
00947     {
00948       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
00949       {
00950         return "حقول بيانات";
00951       }
00952       else
00953       {
00954         return "صفات عامة";
00955       }
00956     }
00957     virtual QCString trStaticPublicAttribs()
00958     {
00959       return "صفات ساكنة عامة";
00960     }
00961     virtual QCString trProtectedTypes()
00962     {
00963       return "أنواع محمية";
00964     }
00965     virtual QCString trProtectedAttribs()
00966     {
00967       return "صفات محمية";
00968     }
00969     virtual QCString trStaticProtectedAttribs()
00970     {
00971       return "صفات ساكنة محمية";
00972     }
00973     virtual QCString trPrivateTypes()
00974     {
00975       return "أنواع خاصة";
00976     }
00977     virtual QCString trPrivateAttribs()
00978     {
00979       return "صفات خاصة";
00980     }
00981     virtual QCString trStaticPrivateAttribs()
00982     {
00983       return "صفات ساكنة خاصة";
00984     }
00985 
00987 // new since 1.1.3
00989 
00991     virtual QCString trTodo()
00992     {
00993       return "مهام";
00994     }
00996     virtual QCString trTodoList()
00997     {
00998       return "قائمة المهام";
00999     }
01000 
01002 // new since 1.1.4
01004 
01005     virtual QCString trReferencedBy()
01006     {
01007       return "ذكر بواسطة";
01008     }
01009     virtual QCString trRemarks()
01010     {
01011       return "تعليقات";
01012     }
01013     virtual QCString trAttention()
01014     {
01015       return "انتبه";
01016     }
01017     virtual QCString trInclByDepGraph()
01018     {
01019       return "هذا الرسم يوضح الملفات التي ضمنت هذا الملف"
01020              "بصورة مباشرة أو غير مباشرة:";
01021     }
01022     virtual QCString trSince()
01023     {
01024       return "منذ";
01025     }
01026     
01028 // new since 1.1.5
01030 
01032     virtual QCString trLegendTitle()
01033     {
01034       return "Graph Legend";
01035     }
01039     virtual QCString trLegendDocs()
01040     {
01041       return 
01042         "This page explains how to interpret the graphs that are generated "
01043         "by doxygen.<p>\n"
01044         "Consider the following example:\n"
01045         "\\code\n"
01046         "/*! Invisible class because of truncation */\n"
01047         "class Invisible { };\n\n"
01048         "/*! Truncated class, inheritance relation is hidden */\n"
01049         "class Truncated : public Invisible { };\n\n"
01050         "/* Class not documented with doxygen comments */\n"
01051         "class Undocumented { };\n\n"
01052         "/*! Class that is inherited using public inheritance */\n"
01053         "class PublicBase : public Truncated { };\n\n"
01054         "/*! A template class */\n"
01055         "template<class T> class Templ { };\n\n"
01056         "/*! Class that is inherited using protected inheritance */\n"
01057         "class ProtectedBase { };\n\n"
01058         "/*! Class that is inherited using private inheritance */\n"
01059         "class PrivateBase { };\n\n"
01060         "/*! Class that is used by the Inherited class */\n"
01061         "class Used { };\n\n"
01062         "/*! Super class that inherits a number of other classes */\n"
01063         "class Inherited : public PublicBase,\n"
01064         "                  protected ProtectedBase,\n"
01065         "                  private PrivateBase,\n"
01066         "                  public Undocumented\n"
01067         "                  public Templ<int>\n"
01068         "{\n"
01069         "  private:\n"
01070         "    Used *m_usedClass;\n"
01071         "};\n"
01072         "\\endcode\n"
01073         "If the \\c MAX_DOT_GRAPH_HEIGHT tag in the configuration file "
01074         "is set to 240 this will result in the following graph:"
01075         "<p><center><img alt=\"\" src=\"graph_legend."+Config_getEnum("DOT_IMAGE_FORMAT")+"\"></center>\n"
01076         "<p>\n"
01077         "The boxes in the above graph have the following meaning:\n"
01078         "<ul>\n"
01079         "<li>%A filled black box represents the struct or class for which the "
01080         "graph is generated.\n"
01081         "<li>%A box with a black border denotes a documented struct or class.\n"
01082         "<li>%A box with a grey border denotes an undocumented struct or class.\n"
01083         "<li>%A box with a red border denotes a documented struct or class for"
01084         "which not all inheritance/containment relations are shown. %A graph is "
01085         "truncated if it does not fit within the specified boundaries.\n"
01086         "</ul>\n"
01087         "The arrows have the following meaning:\n"
01088         "<ul>\n"
01089         "<li>%A dark blue arrow is used to visualize a public inheritance "
01090         "relation between two classes.\n"
01091         "<li>%A dark green arrow is used for protected inheritance.\n"
01092         "<li>%A dark red arrow is used for private inheritance.\n"
01093         "<li>%A purple dashed arrow is used if a class is contained or used "
01094         "by another class. The arrow is labeled with the variable(s) "
01095         "through which the pointed class or struct is accessible.\n"
01096         "<li>%A yellow dashed arrow denotes a relation between a template instance and "
01097         "the template class it was instantiated from. The arrow is labeled with "
01098         "the template parameters of the instance.\n"
01099         "</ul>\n";
01100     }
01102     virtual QCString trLegend()
01103     {
01104       return "legend";
01105     }
01106     
01108 // new since 1.2.0
01110     
01112     virtual QCString trTest()
01113     {
01114       return "اختبار";
01115     }
01117     virtual QCString trTestList()
01118     {
01119       return "قائمة الإختبارات";
01120     }
01121 
01123 // new since 1.2.1
01125 
01127     virtual QCString trDCOPMethods()
01128     {
01129       return "DCOP Member Functions";
01130     }
01131 
01133 // new since 1.2.2
01135 
01137     virtual QCString trProperties()
01138     {
01139       return "خصائص";
01140     }
01142     virtual QCString trPropertyDocumentation()
01143     {
01144       return "توثيق الخاصية";
01145     }
01146 
01148 // new since 1.2.4
01150 
01152     virtual QCString trInterfaces()
01153     {
01154       return "واجهات";
01155     }
01157     virtual QCString trClasses()
01158     {
01159       if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
01160       {
01161         return "هياكل البيانات";
01162       }
01163       else
01164       {
01165         return "فئات";
01166       }
01167     }
01169     virtual QCString trPackage(const char *name)
01170     {
01171       return (QCString)"حزمة "+name;
01172     }
01174     virtual QCString trPackageList()
01175     {
01176       return "قائمة الحزم";
01177     }
01179     virtual QCString trPackageListDescription()
01180     {
01181                 return "هذه هي الحزم مع وصف مختصر لكل منها )إن وجد( :";   
01182     }
01184     virtual QCString trPackages()
01185     {
01186       return "حزم";
01187     }
01189     virtual QCString trPackageDocumentation()
01190     {
01191       return "توثيق الحزم";
01192     }
01194     virtual QCString trDefineValue()
01195     {
01196                 return "القيمة:";
01197     }
01198     
01200 // new since 1.2.5
01202     
01204     virtual QCString trBug()
01205     {
01206       return "ثغرة";
01207     }
01209     virtual QCString trBugList()
01210     {
01211       return "قائمة الثغرات";
01212     }
01213 
01215 // new since 1.2.6
01217 
01243     virtual QCString trRTFansicp()
01244     {
01245       return "1256";
01246     }
01247     
01248 
01252     virtual QCString trRTFCharSet()
01253     {
01254       return "0";
01255     }
01256 
01258     virtual QCString trRTFGeneralIndex()
01259     {
01260       return "فهرس";
01261     }
01262    
01267     virtual QCString trClass(bool /*first_capital*/, bool singular)
01268     { 
01269       QCString result("فئة");
01270       if (!singular)  result="فئات";
01271       return result; 
01272     }
01273 
01278     virtual QCString trFile(bool /*first_capital*/, bool singular)
01279     { 
01280       QCString result("ملف");
01281       if (!singular)  result="ملفات";
01282       return result; 
01283     }
01284 
01289     virtual QCString trNamespace(bool /*first_capital*/, bool singular)
01290     { 
01291       QCString result("مجال أسماء");
01292       if (!singular)  result="مجالات أسماء";
01293       return result; 
01294     }
01295 
01300     virtual QCString trGroup(bool /*first_capital*/, bool singular)
01301     { 
01302       QCString result("مجموعة");
01303       if (!singular)  result="مجموعات";
01304       return result; 
01305     }
01306 
01311     virtual QCString trPage(bool /*first_capital*/, bool singular)
01312     { 
01313       QCString result("صفحة");
01314       if (!singular)  result="صفحات";
01315       return result; 
01316     }
01317 
01322     virtual QCString trMember(bool /*first_capital*/, bool singular)
01323     { 
01324       QCString result("عضو");
01325       if (!singular)  result="أعضاء";
01326       return result; 
01327     }
01328    
01333     virtual QCString trField(bool /*first_capital*/, bool singular)
01334     { 
01335       QCString result("حقل");
01336       if (!singular)  result="حقول";
01337       return result; 
01338     }
01339 
01344     virtual QCString trGlobal(bool /*first_capital*/, bool singular)
01345     { 
01346       QCString result("عام");
01347       if (!singular)  result="عوام";
01348       return result; 
01349     }
01350 
01352 // new since 1.2.7
01354 
01357     virtual QCString trAuthor(bool /*first_capital*/, bool singular)
01358     {                                                                         
01359       QCString result("المؤلف");
01360       if (!singular)  result="المؤلفون";
01361       return result; 
01362     }
01363 
01365 // new since 1.2.11
01367 
01370     virtual QCString trReferences()
01371     {
01372       return "مرجعيات";
01373     }
01374 
01376 // new since 1.2.13
01378 
01382     virtual QCString trImplementedFromList(int numEntries)
01383     {
01384       return "Implements "+trWriteList(numEntries)+".";
01385     }
01386 
01390     virtual QCString trImplementedInList(int numEntries)
01391     {
01392       return "Implemented in "+trWriteList(numEntries)+".";
01393     }
01394 
01396 // new since 1.2.16
01398 
01402     virtual QCString trRTFTableOfContents()
01403     {
01404       return "جدول المحتويات";
01405     }
01406 
01408 // new since 1.2.17
01410 
01414     virtual QCString trDeprecatedList()
01415     {
01416       return "Deprecated List";
01417     }
01418 
01420 // new since 1.2.18
01422 
01426     virtual QCString trEvents()
01427     {
01428       return "الأحداث";
01429     }
01431     virtual QCString trEventDocumentation()
01432     {
01433       return "توثيق الأحداث";
01434     }
01435 
01437 // new since 1.3
01439 
01442     virtual QCString trPackageTypes()
01443     { 
01444       return "أنواع الحزمة";
01445     }
01449     virtual QCString trPackageMembers()
01450     { 
01451       return "دوال الحزمة";
01452     }
01456     virtual QCString trStaticPackageMembers()
01457     { 
01458       return "دوال ساكنة للحزمة";
01459     }
01463     virtual QCString trPackageAttribs()
01464     { 
01465       return "خصائص الحزمة";
01466     }
01470     virtual QCString trStaticPackageAttribs()
01471     { 
01472       return "خصائص ساكنة للحزمة";
01473     }
01474     
01476 // new since 1.3.1
01478 
01482     virtual QCString trAll()
01483     {
01484       return "الكل";
01485     }
01487     virtual QCString trCallGraph()
01488     {
01489                 return "هذا هو رسم الاستدعاء لهذه الدالة:";
01490     }
01491 
01493 // new since 1.3.3
01495 
01500     virtual QCString trSearchForIndex()
01501     {
01502       return "بحث عن";
01503     }
01507     virtual QCString trSearchResultsTitle()
01508     {
01509       return "نتائج البحث";
01510     }
01519     virtual QCString trSearchResults(int numDocuments)
01520     {
01521       if (numDocuments==0)
01522       {
01523         return "عفوا ، لا يوجد توثيق ملائم لما بحثت عنه.";
01524       }
01525       else if (numDocuments==1)
01526       {
01527         return "وثيقة مناسبة لما بحثت عنه. <b>1</b> تم العثور على.";
01528       }
01529       else 
01530       {
01531         return "وثيقة مطابقة لما بحثت عنه <b>$num</b> تم إيجاد ."
01532                "وتم ترتيبهم بحيث يكون الأقرب لنتيجة البحث أولا.";
01533       }
01534     }
01538     virtual QCString trSearchMatches()
01539     {
01540                 return "يتطابق مع:";
01541     }
01542 
01544 // new since 1.3.8
01546 
01549     virtual QCString trSourceFile(QCString& filename)
01550     {
01551       return " ملف المصدر" + filename ;
01552     }
01553 
01555 // new since 1.3.9
01557 
01561     virtual QCString trDirIndex()
01562     { return "شكل هرمي للأدلة"; }
01563 
01567     virtual QCString trDirDocumentation()
01568     { return "توثيق الأدلة"; }
01569 
01573     virtual QCString trDirectories()
01574     { return "الأدلة"; }
01575 
01579     virtual QCString trDirDescription()
01580     { return "هذا الشكل الهرمي للأدلة تم ترتيبه أبجديا بصورة تقريبية، "
01581         "وليس ترتيبا أبجديا كاملا:";
01582     }
01583 
01587     virtual QCString trDirReference(const char *dirName)
01588     { QCString result=" مرجع الدليل"; result+=dirName; return result; }
01589 
01593     virtual QCString trDir(bool first_capital, bool singular)
01594     { 
01595       QCString result((first_capital ? "Director" : "director"));
01596       if (singular) result+="y"; else result+="ies";
01597       return result; 
01598     }
01599 
01601 // new since 1.4.1
01603 
01607     virtual QCString trOverloadText()
01608     {
01609        return "هذه دالة عضو زائدة التحميل ،"
01610               "وجد أنها ملائمة. إنها تختلف عن الدالة أعلاه"
01611               "فقط في نوعية ال argument(s) التي تقبلها.";
01612     }
01613 };
01614 
01615 #endif



Generated on Mon Mar 31 10:58:44 2008 by  doxygen 1.5.1