QuranGetters extension

Extensions on QuranCtrl that provides getters for QuranCtrl's properties.

on

• QuranCtrl

Properties

currentDisplayMode → QuranDisplayMode

Available on QuranCtrl, provided by the QuranGetters extension

الوضع الحالي للعرض Current display mode

no setter

currentFontFamily → String

Available on QuranCtrl, provided by the QuranGetters extension

Get current font family for the selected recitation

no setter

currentPageAyahs → List<AyahModel>

Available on QuranCtrl, provided by the QuranGetters extension

Determines if there is a Sajda (prostration) on the given page of Ayahs.

no setter

currentRecitation → QuranRecitation

Available on QuranCtrl, provided by the QuranGetters extension

-------- Getter ---------- Get current recitation based on fontsSelected value

no setter

isDownloadedFonts → RxBool

Available on QuranCtrl, provided by the QuranGetters extension

no setter

isDownloadFonts → bool

Available on QuranCtrl, provided by the QuranGetters extension

Checks if the fonts are downloaded locally.

no setter

isPreparingDownloadFonts → bool

Available on QuranCtrl, provided by the QuranGetters extension

no setter

quranPagesController ↔ PreloadPageController

Available on QuranCtrl, provided by the QuranGetters extension

getter/setter pair

Methods

getAvailableModes(BuildContext context) → List<QuranDisplayMode>

Available on QuranCtrl, provided by the QuranGetters extension

الأوضاع المتاحة حسب الاتجاه وحجم الشاشة Available modes based on orientation and screen size

getAyahUnqNumberByPageAndIndex(int page, int index) → int

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the unique Ayah number for a specific Ayah on a given page.

getAyahUnqNumberBySurahAndAyahNumber(int surahNumber, int ayahNumber) → int

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the unique Ayah number for a specific Ayah given its Surah and Ayah numbers.

getCurrentJuzNumber(int juzNum) → bool

Available on QuranCtrl, provided by the QuranGetters extension

Checks if the current Juz number matches the specified Juz number.

getCurrentPageAyahsSeparatedForBasmalah(int pageIndex) → List<List<AyahModel>>

Available on QuranCtrl, provided by the QuranGetters extension

Returns a list of lists of AyahModel, where each sublist contains Ayahs that are separated by a Basmalah, for the given page index.

getCurrentPageAyahsSeparatedForBasmalahQcfV1AsLines(int pageIndex) → List<List<LineModel>>

Available on QuranCtrl, provided by the QuranGetters extension

getCurrentSurahByPageNumber(int pageNumber) → SurahModel

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the current Surah data for a given page number.

getCurrentSurahNumber(int surahNum) → bool

Available on QuranCtrl, provided by the QuranGetters extension

Checks if the current Surah number matches the specified Surah number.

getHizbQuarterDisplayByPage(int pageNumber) → String

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the display string for the Hizb quarter of the given page number.

getHizbStartPage(int hizbNumber) → AyahModel

Available on QuranCtrl, provided by the QuranGetters extension

getJuzByPage(int page) → AyahModel

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the Juz data for a given page number.

getJuzStartPage(int juzNumber) → AyahModel

Available on QuranCtrl, provided by the QuranGetters extension

getPageAyahsByIndex(int pageIndex) → List<AyahModel>

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves a list of AyahModel for a specific page index.

getPageNumberByAyahAndSurahNumber(int ayahNumber, int surahNumber) → int

Available on QuranCtrl, provided by the QuranGetters extension

getPageNumberByAyahNumber(int ayahNumber) → int

Available on QuranCtrl, provided by the QuranGetters extension

get page number by ayah number

getPageNumberByAyahUqNumber(int ayahUnequeNumber) → int

Available on QuranCtrl, provided by the QuranGetters extension

get page number by ayah unique number

getSingleAyahByAyahAndSurahNumber(int ayahNumber, int surahNumber) → AyahModel

Available on QuranCtrl, provided by the QuranGetters extension

getSurahDataByAyah(AyahModel ayah) → SurahModel

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the Surah data for a given Ayah.

getSurahDataByAyahUQ(int ayah) → SurahModel

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the Surah data for a given unique Ayah number.

getSurahNumberFromPage(int pageNumber) → int

Available on QuranCtrl, provided by the QuranGetters extension

will return the surah number of the first ayahs.. even if the page contains another surah.

getSurahsByPageNumber(int pageNumber) → List<SurahModel>

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves a list of Surahs present on a specific page.

getTajweedRulesListForLanguage({required String languageCode, String fallbackLanguageCode = 'ar'}) → List<TajweedRuleModel>

Available on QuranCtrl, provided by the QuranGetters extension

isThereAnySajdaInPage(int pageIndex) → bool

Available on QuranCtrl, provided by the QuranGetters extension

Retrieves the Ayah with a Sajda (prostration) on the given page.

loadSavedDisplayMode() → void

Available on QuranCtrl, provided by the QuranGetters extension

تحميل آخر وضع عرض محفوظ من التخزين المحلي Load saved display mode from local storage

selectRecitation(QuranRecitation recitation, {bool isFontsLocal = false}) → Future<void>

Available on QuranCtrl, provided by the QuranGetters extension

اختيار قراءة/خط المصحف باستخدام QuranRecitation كمصدر الحقيقة.

setDisplayMode(QuranDisplayMode mode) → void

Available on QuranCtrl, provided by the QuranGetters extension

تعيين وضع العرض مع الحفظ في التخزين المحلي Set display mode and persist to local storage

showControlToggle({bool enableMultiSelect = false}) → void

Available on QuranCtrl, provided by the QuranGetters extension

switchFontType({required int fontIndex}) → Future<void>

Available on QuranCtrl, provided by the QuranGetters extension

تبديل نوع الخط وتحميله إذا لم يكن محملاً من قبل