TreeStructInfo 2.0
Oficjalna dokumentacja API napisanego w języku Free Pascal.
Niniejsza biblioteka do obsługi plików TreeStructInfo przeznaczona jest dla kompilatorów FPC w wersji co najmniej 3.0.0 (z obsługą nowego silnika dla Unikodu). Udostępniana jest na zasadach licencji GNU Lesser General Public License 3, z otwartym kodem oraz możliwością jej wszelakich zastosowań.
Kod biblioteki został napisany tak, aby jej wykorzystanie było maksymalnie łatwe oraz intuicyjne. Jeżeli nie wiesz jeszcze jak się nim posługiwać, zapoznaj się z tutorialami, opisującymi wykorzystanie klas biblioteki.
Jeśli potrzebujesz zapoznać się z pojedynczą składową biblioteki (np. metodą klasy), odszukaj ją za pomocą poniższej listy. Dokumentacja poszczególnych elementów biblioteki nie została wygenerowana automatycznie na podstawie kodu źródłowego. Zawarte są w niej szczegółowe opisy wszystkich składowych biblioteki, wraz z numerem linii ich deklaracji.
Biblioteka ta podzielona jest na cztery tematyczne moduły. Wydzielone zostały do osobnych plików klasy używane do budowy drzewa w pamięci i ogólnej obsługi plików TreeStructInfo, wspólne dla biblioteki procedury i funkcje, a także typy danych oraz stałe. Kliknij w nazwę modułu aby przejść do opisu jego zawartości.
| moduły | |
|---|---|
| TSInfoConsts | obejmuje zestaw kilkudziesięciu stałych, wykorzystywanych w pozostałych modułach biblioteki |
| TSInfoTypes | zawiera wspólne typy, wykorzystywane w całej bibliotece |
| TSInfoUtils | moduł zawierający algorytmy konwersji danych oraz wspólne procedury i funkcje |
| TSInfoFiles | główny plik biblioteki, zawierający zestaw klas do obsługi plików TreeStructInfo |
Ostatnia aktualizacja: 4 maja 2017.
legenda
W poszczególnych działach dokumentacji przedstawione są listy zawierające różne elementy, m.in. lista z zawartością danej klasy czy lista parametrów danej procedury, funkcji lub metody. Elementy tych list oznaczone są różnymi symbolami, które informują o ich typie lub przeznaczeniu.
Poniżej znajduje się lista wszystkich symboli, używanych w wyżej wymienionych listach, wraz z informacją o ich znaczeniu.
| sekcja | nagłówek danej sekcji listy |
| moduł | modułu biblioteki |
| stała | pojedyncza stała |
| typ | typ danych |
| procedura | procedura lub metoda proceduralna |
| funkcja | funkcja lub metoda funkcyjna |
| parametr | parametr przekazywany przez stałą (ze słowem kluczowym const) |
| parametr | parametr przekazywany przez wartość |
| parametr | parametr przekazywany przez referencję (ze słowem kluczowym var) |
| parametr | parametr przekazywany przez pustą referencję (ze słowem kluczowym out) |
| parametr | parametr typu obiektowego (referencja instancji klasy) |
| klasa | klasa biblioteki |
| pole | prywatne pole klasy |
| właściwość | publiczna właściwość klasy |
| metoda abstrakcyjna | abstrakcyjna proceduralna lub funkcyjna metoda klasy |