Заглавная страница: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(не показана 21 промежуточная версия этого же участника)
Строка 1: Строка 1:
[[Файл:Promo-slide.jpg|640px]]
+
== Модули ==
  
Добро пожаловать в документацию по всему, что связано с библиотекой FGX Native.
+
{| class="wikitable sortable"
 
+
|-
{|
+
| [[FGX.ActivityIndicator]] || <p>Компонент "индикатор активности".</p>
 +
|-
 +
| [[FGX.Animation]] || <p>Абстракции для работы с анимацией.</p>
 +
|-
 +
| [[FGX.Application.Appearance]] || <p>Описание общих настроек внешнего вида приложения.</p>
 +
|-
 +
| [[FGX.Application.Events]] || <p>Централизованный сбор основных событий приложения.</p>
 +
|-
 +
| [[FGX.Application.Info]] || <p>Информация о приложении (версия, название пакета и тд).</p>
 +
|-
 +
| [[FGX.Application]] || <p>Описание основы приложения.</p>
 +
|-
 +
| [[FGX.Arc]] || <p>Компонент-примитив дуга.</p>
 +
|-
 +
| [[FGX.Arch]] || <p>Компонент-примитив толстая дуга.</p>
 +
|-
 +
| [[FGX.Asserts]] || <p>Контрактное программирование. Модуль с методами проверок предусловий.</p>
 +
|-
 +
| [[FGX.Assets.BitmapSet]] || <p>Ресурс набор-изображений.</p>
 +
|-
 +
| [[FGX.Assets.Color]] || <p>Ресурс цвета.</p>
 +
|-
 +
| [[FGX.Assets.CustomFile]] || <p>Ресурс с пользовательским файлом.</p>
 +
|-
 +
| [[FGX.Assets.Factory]] || <p>Фабрика по чтению и сохранению мета информации о ресурсах.</p>
 +
|-
 +
| [[FGX.Assets.Font]] || <p>Ресурс файл пользовательского шрифта.</p>
 +
|-
 +
| [[FGX.Assets.Helpers]] || <p>Хелперы расширяющие возможности <i>TfgAssetsManager</i> .</p>
 +
|-
 +
| [[FGX.Assets.Types]] || <p>Вспомогательные типы для реализации ресурсов.</p>
 +
|-
 +
| [[FGX.Assets]] || <p>Основная реализация работы с ресурсами.</p>
 +
|-
 +
| [[FGX.AutoCompleteEdit.Types]] || <p>Вспомогательные типы для реализации поля ввода с автозавершением.</p>
 +
|-
 +
| [[FGX.AutoCompleteEdit]] || <p>Компонент поле ввода с автозавершением.</p>
 +
|-
 +
| [[FGX.Button.Types]] || <p>Вспомогательные типы для реализации кнопки.</p>
 +
|-
 +
| [[FGX.Button]] || <p>Компонент кнопка.</p>
 +
|-
 +
| [[FGX.Calendar.Types]] || <p>Вспомогательные типы для реализации календаря.</p>
 +
|-
 +
| [[FGX.Calendar]] || <p>Компонент календарь.</p>
 +
|-
 +
| [[FGX.Camera.Preview]] || <p>Компонент для отображения превью с камеры.</p>
 +
|-
 +
| [[FGX.Camera]] || <p>Модуль по работе с камерами.</p>
 +
|-
 +
| [[FGX.Canvas.Types]] || <p>Вспомогательные типы для реализации графики.</p>
 +
|-
 +
| [[FGX.Canvas]] || <p>Абстракции по работе с графикой.</p>
 +
|-
 +
| [[FGX.CardPanel]] || <p>Компонент контейнер-карточка.</p>
 +
|-
 +
| [[FGX.Check]] || <span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| [[FGX.CheckBox]] || <p>Компонент CheckBox.</p>
 +
|-
 +
| [[FGX.Circle]] || <p>Компонент-примитив окружности.</p>
 +
|-
 +
| [[FGX.ClassStorage]] || <span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| [[FGX.CollectionView]] || <p>Компонент быстрый список.</p>
 +
|-
 +
| [[FGX.ComboBox]] || <p>Компонент выпадающий список.</p>
 +
|-
 +
| [[FGX.Consts]] || <p>Основные константы FGX Native.</p>
 +
|-
 +
| [[FGX.Controls.Factory]] || <p>Абстрактная фабрика по созданию нативных компонентов.</p>
 +
|-
 +
| [[FGX.Controls.Types]] || <p>Вспомогательные типы для реализации Control.</p>
 +
|-
 +
| [[FGX.Controls]] || <p>Основа всех компонентов - Control.</p>
 +
|-
 +
| [[FGX.DateEdit]] || <p>Модуль компонента <i>TfgDateEdit</i> ("Текстовое поле с мастером выбора даты"). Занимает мало места и отображает дату в текстовом виде.</p>
 +
|-
 +
| [[FGX.DatePicker]] || <p>Компонент выбора даты.</p>
 +
|-
 +
| [[FGX.DateTimeControl]] || <p>Базовые классы используемые для построения компонентов ввода даты/времени.</p>
 +
|-
 +
| [[FGX.Dialogs]] || <p>Абстракции для работы с диалоговыми окнами.</p>
 +
|-
 +
| [[FGX.DrawerLayout]] || <p>Компонент-контейнер выдвигаемая панель.</p>
 +
|-
 +
| [[FGX.Edit]] || <p>Компонент поле ввода.</p>
 +
|-
 +
| [[FGX.Ellipse]] || <p>Компонент-примитив эллипс.</p>
 +
|-
 +
| [[FGX.FlexManager]] || <p>FlexBox dыравнивание.</p>
 +
|-
 +
| [[FGX.Forms.Types]] || <p>Вспомогательные типы для реализации формы.</p>
 +
|-
 +
| [[FGX.Forms]] || <p>Форма.</p>
 +
|-
 +
| [[FGX.GraphicControl]] || <p>Основа для создания грфических компонентов.</p>
 +
|-
 +
| [[FGX.Image]] || <p>Компонент отображение изображения.</p>
 +
|-
 +
| [[FGX.Layout.Types]] || <p>Вспомогательные типы для реализации контейнера FlexBox.</p>
 +
|-
 +
| [[FGX.Layout]] || <p>Компонент-контейнер поддерживаемый FlexBox разметку.</p>
 +
|-
 +
| [[FGX.Line]] || <p>Компонент-примитив линия.</p>
 +
|-
 +
| [[FGX.ListMenu.Types]] || <p>Дополнительные типы данных для реализации меню <i>TfgListMenu</i> .</p>
 +
|-
 +
| [[FGX.ListMenu]] || <p>Компонент меню на базе списка.</p>
 +
|-
 +
| [[FGX.Log]] || <p>Абстракции логирования.</p>
 +
|-
 +
| [[FGX.Map.Types]] || <p>Вспомогательные типы для <i>TfgMap</i> .</p>
 +
|-
 +
| [[FGX.Map]] || <p>Компонент географическая карта.</p>
 +
|-
 +
| [[FGX.Memo]] || <p>Компонент многострочный ввод текста.</p>
 +
|-
 +
| [[FGX.Messaging]] || <p>Система обмена сообщениями.</p>
 +
|-
 +
| [[FGX.NavigationBar.Types]] || <p>Вспомогательные типы для реализации панели навигации.</p>
 +
|-
 +
| [[FGX.NavigationBar]] || <p>Компонент основная панель навигации.</p>
 +
|-
 +
| [[FGX.PageControl]] || <p>Компонент-контейнер многостраничный контейнер с вкладками.</p>
 +
|-
 +
| [[FGX.PaintBox]] || <p>Компонент-примитив для пользовательской отрисовки.</p>
 +
|-
 +
| [[FGX.Permissions]] || <p>Абстракции для работы с системой запроса разрешений.</p>
 +
|-
 +
| [[FGX.Pickers.Date]] || <p>Абстракция для выполнения кроссплатформенного запроса выбора даты пользователем.</p>
 +
|-
 +
| [[FGX.Pickers.Time]] || <p>Абстракция для выполнения кроссплатформенного запроса выбора времени пользователем.</p>
 +
|-
 +
| [[FGX.Pickers]] || <p>Абстракция для описания общих методов по работе с вводом данных пользователем в UI.</p>
 +
|-
 +
| [[FGX.Platform.KeyMapping]] || <p>Маппинг нативных кодов клавиш в виртуальный и наоборот.</p>
 +
|-
 +
| [[FGX.Platform]] || <p>Основные абстракции платформы, необходимые для минимальной работы.</p>
 +
|-
 +
| [[FGX.ProgressBar]] || <p>Компонент полоса прогресса.</p>
 +
|-
 +
| [[FGX.RadioButton]] || <p>Компонент радио кнопка.</p>
 +
|-
 +
| [[FGX.Rectangle.Types]] || <p>Вспомогательные типы для реализации компонента-примитива "прямоугольник".</p>
 +
|-
 +
| [[FGX.Rectangle]] || <p>Компонент-примитив прямоугольник.</p>
 +
|-
 +
| [[FGX.RegularPolygon]] || <p>Компонент-примитив правильный многоугольник.</p>
 +
|-
 +
| [[FGX.Rhomb]] || <p>Компонент-примитив ромб.</p>
 +
|-
 +
| [[FGX.Scaner.Barcode]] || <p>Модуль сканера распознавания различных видов баркодов.</p>
 +
|-
 +
| [[FGX.ScrollBox]] || <p>Компонент-контейнер прокручиваемый контент.</p>
 +
|-
 +
| [[FGX.SearchEdit]] || <p>Компонент поле поиска со списком текстовых предложений.</p>
 +
|-
 +
| [[FGX.Sector]] || <p>Компонент-примитив сектор.</p>
 +
|-
 +
| [[FGX.Shape]] || <p>Основа для реализации компонентов примитивов.</p>
 +
|-
 +
| [[FGX.Spacer]] || <p>Компонент заполнитель свободного пространства.</p>
 +
|-
 +
| [[FGX.StaticLabel]] || <p>Компонент текстовая метка.</p>
 +
|-
 +
| [[FGX.SvgPath]] || <p>Компонент-примитив SVG кривая.</p>
 +
|-
 +
| [[FGX.Switch]] || <p>Компонент переключатель.</p>
 +
|-
 +
| [[FGX.SystemInfo]] || <p>Абстракции для получения системной информации.</p>
 +
|-
 +
| [[FGX.Text]] || <p>Вспомогательные типы данных и методы обработки текста.</p>
 +
|-
 +
| [[FGX.TimeEdit]] || <p>Модуль компонента <i>TfgTimeEdit</i> ("Текстовое поле с мастером выбора времени"). Занимает мало места и отображает время в текстовом виде.</p>
 +
|-
 +
| [[FGX.TimePicker]] || <p>Модуль компонента <i>TfgTimePicker</i> ("Удобный интерактивный выбор времени"). Компонент занимает много места на экране.</p>
 +
|-
 +
| [[FGX.Timer]] || <p>Модуль компонента <i>TfgTimer</i> . Содержит обертку-компонент, работающую с системным сервисом <i>IFGXTimerService</i> .</p>
 +
|-
 +
| [[FGX.Toasts]] || <p>Модуль отображения всплывающих подсказок <i>TfgToast</i> .</p>
 +
|-
 +
| [[FGX.ToolBar]] || <p>Модуль компонента <i>TfgToolBar</i> ("инструментальная панель").</p>
 +
|-
 +
| [[FGX.TrackBar]] || <p>Модуль компонента <i>TfgTrackBar</i> ("ползунок выбора вещественного числа из диапазона").</p>
 +
|-
 +
| [[FGX.Types.AutoreleasePool]] || <p>Модуль для отложенного удаления объектов. Используется в ситуациях, когда нужно отложенно удалить объект без сохранения ссылки на этот объект в модели управления памяти ARC.</p>
 +
|-
 +
| [[FGX.Types.Border]] || <p>Параметры границы <i>TfgBorder</i> .</p>
 +
|-
 +
| [[FGX.Types.Shadow]] || <p>Настройки теней.</p>
 
|-
 
|-
| [[Файл:Icon-install.png]] || Перед тем как начать, необходимо настроить свое рабочее окружение:
+
| [[FGX.Types.StateValue]] || <p>Счетчик состояния <i>TfgStateValue</i> , используется для контролирования парных вызовов <i>BeginUpdate</i> - <i>EndUpdate</i> .</p>
* Установка FGX Native
 
* Настройка Android окружения
 
* Установка Android Studio (опционально)
 
 
|-
 
|-
| [[Файл:Icon-rocket.png]] || Создай свое первое "Hello World" мобильное приложение или открой один из демо проектов:
+
| [[FGX.Types]] || <p>Базовые низкоуровневые вспомогательные типы.</p>
* Создание первого мобильного проекта
 
* [[Каталог демо проектов]]
 
 
|-
 
|-
| [[Файл:Icon-api.png]] || Подробности использования API можно посмотреть в xml-документации исходных кодов или здесь на сайте:
+
| [[FGX.VideoControl]] || <p>Видео прогрыватель.</p>
* [[FGX|API библиотеки]]
 
 
|-
 
|-
| [[Файл:Icon-faq.png]] || Появились проблемы или вопросы, посмотри тут:
+
| [[FGX.VirtualKeyboard]] || <p>Все для работы с виртуальной клавиатурой.</p>
* [[Часто встречаемые проблемы]]
 
 
|-
 
|-
| [[Файл:Icon-bug.png]] || И наконец, все найденный ошибки, проблемы, идеи, предложения и пожелания заводите в баг трекер:
+
| [[FGX.WebBrowser]] || <p>Веб браузер.</p>
* https://gitlab.com/y.brovin/fgx/issues
 
 
 
 
|}
 
|}
 
 
 
 
 
 
 
 
3. О библиотеке
 
 
* [[Система выравнивания]]
 
* [[Ресурсы приложения]]
 
 
4. Решение часто возникающих проблем.
 
* [[Часто встречаемые проблемы]]
 
 
 
# Статьи по использования библиотеки FGX Native.
 
#* [[Начало работы]]
 
#* [[Системные требования]]
 
#* [[Полезные ссылки]]
 
#* [[История изменений]]
 
 
<div class="info">
 
Документация находится на стадии разработки. Если вы не нашли ответа на свой вопрос, пожалуйста, напишите об этом в Slack канале [https://fgx-native-ru.slack.com/messages/CKQCRACPP/details/ #документация]
 
</div>
 

Версия 23:34, 20 ноября 2019

Модули

FGX.ActivityIndicator

Компонент "индикатор активности".

FGX.Animation

Абстракции для работы с анимацией.

FGX.Application.Appearance

Описание общих настроек внешнего вида приложения.

FGX.Application.Events

Централизованный сбор основных событий приложения.

FGX.Application.Info

Информация о приложении (версия, название пакета и тд).

FGX.Application

Описание основы приложения.

FGX.Arc

Компонент-примитив дуга.

FGX.Arch

Компонент-примитив толстая дуга.

FGX.Asserts

Контрактное программирование. Модуль с методами проверок предусловий.

FGX.Assets.BitmapSet

Ресурс набор-изображений.

FGX.Assets.Color

Ресурс цвета.

FGX.Assets.CustomFile

Ресурс с пользовательским файлом.

FGX.Assets.Factory

Фабрика по чтению и сохранению мета информации о ресурсах.

FGX.Assets.Font

Ресурс файл пользовательского шрифта.

FGX.Assets.Helpers

Хелперы расширяющие возможности TfgAssetsManager .

FGX.Assets.Types

Вспомогательные типы для реализации ресурсов.

FGX.Assets

Основная реализация работы с ресурсами.

FGX.AutoCompleteEdit.Types

Вспомогательные типы для реализации поля ввода с автозавершением.

FGX.AutoCompleteEdit

Компонент поле ввода с автозавершением.

FGX.Button.Types

Вспомогательные типы для реализации кнопки.

FGX.Button

Компонент кнопка.

FGX.Calendar.Types

Вспомогательные типы для реализации календаря.

FGX.Calendar

Компонент календарь.

FGX.Camera.Preview

Компонент для отображения превью с камеры.

FGX.Camera

Модуль по работе с камерами.

FGX.Canvas.Types

Вспомогательные типы для реализации графики.

FGX.Canvas

Абстракции по работе с графикой.

FGX.CardPanel

Компонент контейнер-карточка.

FGX.Check Описание отсутствует.
FGX.CheckBox

Компонент CheckBox.

FGX.Circle

Компонент-примитив окружности.

FGX.ClassStorage Описание отсутствует.
FGX.CollectionView

Компонент быстрый список.

FGX.ComboBox

Компонент выпадающий список.

FGX.Consts

Основные константы FGX Native.

FGX.Controls.Factory

Абстрактная фабрика по созданию нативных компонентов.

FGX.Controls.Types

Вспомогательные типы для реализации Control.

FGX.Controls

Основа всех компонентов - Control.

FGX.DateEdit

Модуль компонента TfgDateEdit ("Текстовое поле с мастером выбора даты"). Занимает мало места и отображает дату в текстовом виде.

FGX.DatePicker

Компонент выбора даты.

FGX.DateTimeControl

Базовые классы используемые для построения компонентов ввода даты/времени.

FGX.Dialogs

Абстракции для работы с диалоговыми окнами.

FGX.DrawerLayout

Компонент-контейнер выдвигаемая панель.

FGX.Edit

Компонент поле ввода.

FGX.Ellipse

Компонент-примитив эллипс.

FGX.FlexManager

FlexBox dыравнивание.

FGX.Forms.Types

Вспомогательные типы для реализации формы.

FGX.Forms

Форма.

FGX.GraphicControl

Основа для создания грфических компонентов.

FGX.Image

Компонент отображение изображения.

FGX.Layout.Types

Вспомогательные типы для реализации контейнера FlexBox.

FGX.Layout

Компонент-контейнер поддерживаемый FlexBox разметку.

FGX.Line

Компонент-примитив линия.

FGX.ListMenu.Types

Дополнительные типы данных для реализации меню TfgListMenu .

FGX.ListMenu

Компонент меню на базе списка.

FGX.Log

Абстракции логирования.

FGX.Map.Types

Вспомогательные типы для TfgMap .

FGX.Map

Компонент географическая карта.

FGX.Memo

Компонент многострочный ввод текста.

FGX.Messaging

Система обмена сообщениями.

FGX.NavigationBar.Types

Вспомогательные типы для реализации панели навигации.

FGX.NavigationBar

Компонент основная панель навигации.

FGX.PageControl

Компонент-контейнер многостраничный контейнер с вкладками.

FGX.PaintBox

Компонент-примитив для пользовательской отрисовки.

FGX.Permissions

Абстракции для работы с системой запроса разрешений.

FGX.Pickers.Date

Абстракция для выполнения кроссплатформенного запроса выбора даты пользователем.

FGX.Pickers.Time

Абстракция для выполнения кроссплатформенного запроса выбора времени пользователем.

FGX.Pickers

Абстракция для описания общих методов по работе с вводом данных пользователем в UI.

FGX.Platform.KeyMapping

Маппинг нативных кодов клавиш в виртуальный и наоборот.

FGX.Platform

Основные абстракции платформы, необходимые для минимальной работы.

FGX.ProgressBar

Компонент полоса прогресса.

FGX.RadioButton

Компонент радио кнопка.

FGX.Rectangle.Types

Вспомогательные типы для реализации компонента-примитива "прямоугольник".

FGX.Rectangle

Компонент-примитив прямоугольник.

FGX.RegularPolygon

Компонент-примитив правильный многоугольник.

FGX.Rhomb

Компонент-примитив ромб.

FGX.Scaner.Barcode

Модуль сканера распознавания различных видов баркодов.

FGX.ScrollBox

Компонент-контейнер прокручиваемый контент.

FGX.SearchEdit

Компонент поле поиска со списком текстовых предложений.

FGX.Sector

Компонент-примитив сектор.

FGX.Shape

Основа для реализации компонентов примитивов.

FGX.Spacer

Компонент заполнитель свободного пространства.

FGX.StaticLabel

Компонент текстовая метка.

FGX.SvgPath

Компонент-примитив SVG кривая.

FGX.Switch

Компонент переключатель.

FGX.SystemInfo

Абстракции для получения системной информации.

FGX.Text

Вспомогательные типы данных и методы обработки текста.

FGX.TimeEdit

Модуль компонента TfgTimeEdit ("Текстовое поле с мастером выбора времени"). Занимает мало места и отображает время в текстовом виде.

FGX.TimePicker

Модуль компонента TfgTimePicker ("Удобный интерактивный выбор времени"). Компонент занимает много места на экране.

FGX.Timer

Модуль компонента TfgTimer . Содержит обертку-компонент, работающую с системным сервисом IFGXTimerService .

FGX.Toasts

Модуль отображения всплывающих подсказок TfgToast .

FGX.ToolBar

Модуль компонента TfgToolBar ("инструментальная панель").

FGX.TrackBar

Модуль компонента TfgTrackBar ("ползунок выбора вещественного числа из диапазона").

FGX.Types.AutoreleasePool

Модуль для отложенного удаления объектов. Используется в ситуациях, когда нужно отложенно удалить объект без сохранения ссылки на этот объект в модели управления памяти ARC.

FGX.Types.Border

Параметры границы TfgBorder .

FGX.Types.Shadow

Настройки теней.

FGX.Types.StateValue

Счетчик состояния TfgStateValue , используется для контролирования парных вызовов BeginUpdate - EndUpdate .

FGX.Types

Базовые низкоуровневые вспомогательные типы.

FGX.VideoControl

Видео прогрыватель.

FGX.VirtualKeyboard

Все для работы с виртуальной клавиатурой.

FGX.WebBrowser

Веб браузер.