QuranLibrary class

A class that provides utility functions for interacting with the Quran library.

This class includes methods and properties that facilitate various operations related to the Quran, such as retrieving verses, chapters, and other relevant information.

Example usage:

QuranLibrary quranLibrary = QuranLibrary();
// Use quranLibrary to access various Quran-related utilities.

Note: Ensure that you have the necessary dependencies and configurations set up in your Flutter project to use this class effectively.

Constructors

QuranLibrary.new()
Factory constructor for creating a new instance of QuranLibrary.
factory

Properties

allBookmarks → List<BookmarkModel>
يعيد قائمة بجميع شارات المرجعية المحفوظة allBookmarks.
no setter
allHizb → List<String>
allHizb يعيد قائمة بأسماء جميع أجزاء القرآن.
no setter
allJoz → List<String>
allJoz returns list of all Quran joz' names
no setter
currentFontsSelected → int
لمعرفة الخط الذي تم تحديده، ما عليك سوى إستدعاء currentFontsSelected
no setter
currentPageNumber → int
currentPageNumber تعيد رقم الصفحة التي يكون المستخدم عليها حاليًا. أرقام الصفحات تبدأ من 1، لذا فإن الصفحة الأولى من القرآن هي الصفحة رقم 1.
no setter
fontsDownloadProgress → double
للحصول على تقدم تنزيل الخطوط، ما عليك سوى إستدعاء fontsDownloadProgress
no setter
hafsStyle → TextStyle
لجلب آيات الصفحة عن طريق رقم الصفحة يمكنك إستخدام getTajweedRules.
final
hashCode → int
The hash code for this object.
no setterinherited
isFontsDownloaded → bool
لمعرفة ما إذا كانت الخطوط محملة او لا، ما عليك سوى إستدعاء isFontsDownloaded
no setter
naskhStyle → TextStyle
naskhStyle هو النمط الافتراضي للنصوص الآخرى.
final
quranCtrl → QuranCtrl
A singleton instance of the QuranCtrl class.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
usedBookmarks → List<BookmarkModel>
يعيد قائمة بجميع العلامات المرجعية التي استخدمها وقام بتعيينها المستخدم في صفحات القرآن usedBookmarks.
no setter

Methods

getAllSurahInPageByPageNumber({required int pageNumber}) → List<SurahFontsModel>
لمعرفة أسماء السور في اي صفحة فقط قم بإستدعاء getAllSurahInPageByPageNumber وفقط قم بتمرير رقم الصفحة لها.
getAllSurahs({bool isArabic = true}) → List<String>
getAllSurahs يعيد قائمة بأسماء السور.
getAllSurahsArtPath() → List<String>
getAllSurahsArtPath يعيد قائمة بمسارات المخطوطات الخاصة بإسماء السور.
getCurrentSurahDataByAyah({required AyahFontsModel ayah}) → SurahFontsModel
لجلب بيانات السورة الحالية عن طريق بيانات الآية يمكنك إستخدام getCurrentSurahDataByAyah.
getCurrentSurahDataByAyahUniqueNumber({required int ayahUniqueNumber}) → SurahFontsModel
لجلب بيانات السورة الحالية عن طريق رقم الآية الفريد يمكنك إستخدام getCurrentSurahDataByAyahUniqueNumber.
getCurrentSurahDataByPageNumber({required int pageNumber}) → SurahFontsModel
لجلب بيانات السورة الحالية عن طريق رقم الصفحة يمكنك إستخدام getCurrentSurahDataByPageNumber.
getDeleteFontsMethod() → void
لحذف الخطوط فقط قم بإستدعاء deleteFontsMethod
getFontsDownloadDialog(DownloadFontsDialogStyle? downloadFontsDialogStyle, String? languageCode, {bool isDark = false}) → Widget
للحصول على نافذة حوار خاصة بتحميل الخطوط، قم فقط باستدعاء: getFontsDownloadDialog.
getFontsDownloadMethod({required int fontIndex}) → void
للحصول على طريقة تنزيل الخطوط فقط قم بإستدعاء fontsDownloadMethod
getFontsDownloadWidget(BuildContext context, {DownloadFontsDialogStyle? downloadFontsDialogStyle, String? languageCode, bool isDark = false, bool isFontsLocal = false}) → Widget
للحصول على الويدجت الخاصة بتنزيل الخطوط فقط قم بإستدعاء getFontsDownloadWidget
getFontsPrepareMethod({required int pageIndex, bool? isFontsLocal = false}) → void
للحصول على طريقة تنزيل الخطوط فقط قم بإستدعاء getFontsPrepareMethod مطلوب تمرير رقم الصفحة pageIndex
getJuzByPageNumber({required int pageNumber}) → AyahFontsModel
لجلب رقم الجزء الحالي عن طريق رقم الصفحة يمكنك إستخدام getJuzByPageNumber.
getPageAyahsByPageNumber({required int pageNumber}) → List<AyahFontsModel>
لجلب آيات الصفحة عن طريق رقم الصفحة يمكنك إستخدام getPageAyahsByPageNumber.
getSurahInfo({required int surahNumber}) → SurahNamesModel
getSurahInfo تتيح لك الحصول على سورة مع جميع بياناتها. ملاحظة: تستقبل هذه الطريقة رقم السورة وليس فهرس السورة.
getSurahInfoDialog({required int surahNumber, required BuildContext context, SurahInfoStyle? surahInfoStyle, String? languageCode, bool isDark = false}) → void
للحصول على معلومات السورة في نافذة حوار، قم فقط باستدعاء: getSurahInfoDialog.
init({Map<int, List<BookmarkModel>>? userBookmarks, bool overwriteBookmarks = false}) → Future<void>
init تقوم بتهيئة القرآن ويجب استدعاؤها قبل البدء في استخدام الحزمة
jumpToAyah(int pageNumber, int ayahUQNumber) → void
navigateToAyah يتيح لك التنقل إلى أي آية. من الأفضل استدعاء هذه الطريقة أثناء عرض شاشة القرآن، وإذا تم استدعاؤها ولم تكن شاشة القرآن معروضة، فسيتم بدء العرض من صفحة هذه الآية عند فتح شاشة القرآن في المرة التالية.
jumpToBookmark(BookmarkModel bookmark) → void
jumpToBookmark يتيح لك التنقل إلى علامة مرجعية معينة. ملاحظة: يجب أن يكون رقم صفحة العلامة المرجعية بين 1 و604.
jumpToHizb(int hizb) → void
jumpToHizb يتيح لك التنقل إلى أي جزء في القرآن باستخدام رقم الجزء. ملاحظة: تستقبل هذه الطريقة رقم الجزء وليس فهرس الجزء.
jumpToJoz(int jozz) → void
jumpToJoz let's you navigate to any quran jozz with jozz number Note it receives jozz number not jozz index
jumpToPage(int page) → void
jumpToPage يتيح لك التنقل إلى أي صفحة في القرآن باستخدام رقم الصفحة. ملاحظة: تستقبل هذه الطريقة رقم الصفحة وليس فهرس الصفحة. من الأفضل استدعاء هذه الطريقة أثناء عرض شاشة القرآن، وإذا تم استدعاؤها ولم تكن شاشة القرآن معروضة، فسيتم بدء العرض من هذه الصفحة عند فتح شاشة القرآن في المرة التالية.
jumpToSurah(int surah) → void
jumpToSurah يتيح لك التنقل إلى أي سورة في القرآن باستخدام رقم السورة. ملاحظة: تستقبل هذه الطريقة رقم السورة وليس فهرس السورة.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeBookmark({required int bookmarkId}) → void
يزيل علامة مرجعية من قائمة العلامات المرجعية المحفوظة للمستخدم. bookmarkId هو معرّف العلامة المرجعية التي سيتم إزالتها.
search يبحث في القرآن عن الآيات من خلال الكلمة أو رقم الصفحة. يعيد قائمة بجميع الآيات التي تحتوي نصوصها على النص المُعطى.
setBookmark({required String surahName, required int ayahNumber, required int ayahId, required int page, required int bookmarkId}) → void
يقوم بتعيين علامة مرجعية باستخدام ayahId وpage وbookmarkId المحددة.
surahSearch(String text) → List<AyahModel>
search يبحث في القرآن عن أسماء السور. يعيد قائمة بجميع السور التي يكون أسمها أو رقمها أو رفم الصفحة الخاصة بها مطابق للنص المُعطى.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited