Następna
Poprzednia
Spis treści
Funkcje wbudowane opisane w tym rozdziale dostępne są w trybie artykułów i
pozwalają na manipulowanie oknem nagłówków.
- Składnia
Void collapse_thread ()
- Opis
Wywołanie tej funkcji powoduje zwinięcie bieżącego wątku.
- Zobacz również
uncollapse_thread, collapse_threads, is_thread_collapsed
- Składnia
Void collapse_threads ()
- Opis
Wywołanie tej funkcji powoduje zwinięcie wszystkich wątków w bieżącej
grupie.
- Zobacz również
uncollapse_threads
- Składnia
String_Type extract_article_header (String h)
- Opis
Funkcja ta zwraca linię bieżącego nagłówka określoną przez podanie w
argumencie h słowa kluczowego nagłówka. Bieżący nagłówek
niekoniecznie odpowiada wyświetlanemu artykułowi. Nagłówek skojarzony z
wyświetlanym artykułem zwraca funkcja
extract_displayed_article_header.
Jeśli nagłówek nie istnieje, funkcja zwraca pusty napis.
- Uwagi
Funkcja ta nie odpytuje serwera. Jeśli istnieje potrzeba skorzystania z
linii nagłówka, której nie ma w bazie overview serwera, a która nie
została ściągnięta dla potrzeb kosztownej punktacji, należy ściągnąć
artykuł skojarzony z bieżącym nagłówkiem.
- Zobacz również
extract_displayed_article_header, is_article_visible
- Składnia
String_Type extract_displayed_article_header (String h)
- Opis
Funkcja zwraca linię bieżącego nagłówka określoną przez podanie w
argumencie h słowa kluczowego nagłówka obecnie wyświetlanej
wiadomości.
Jeśli nagłówek nie istnieje, funkcja zwraca pusty napis.
- Zobacz również
extract_displayed_article_header, is_article_visible
- Składnia
Integer get_grouplens_score ()
- Opis
Funkcja zwraca punktację ,,grouplens'' bieżącego nagłówka. Jeśli nagłówek
nie posiada punktacji, funkcja zwróci 0.
- Składnia
Integer get_header_flags ()
- Opis
Funkcja zwraca flagi przypisane bieżącemu nagłówkowi. Jest to liczba
całkowita reprezentująca pole bitowe, którego bity określone są
następującymi stałymi symbolicznymi:
HEADER_READ : ustawiony, jeśli nagłówek jest oznaczony jako przeczytany
HEADER_TAGGED : ustawiony, jeśli nagłówek posiada znacznik '*'
HEADER_HIGH_SCORE : ustawiony, jeśli nagłówek jest oznaczony jako ważny
HEADER_LOW_SCORE : ustawiony, jeśli nagłówek jest oznaczony jako nieważny
- Zobacz również
set_header_flags
- Składnia
Integer get_header_number ()
- Opis
Funkcja ta zwraca numer artykułu skojarzonego z bieżącym nagłówkiem.
- Składnia
Integer get_header_score ()
- Opis
Funkcja ta zwraca punktację bieżącego nagłówka.
- Zobacz również
set_header_score
- Składnia
Integer get_header_tag_number ()
- Opis
Funkcja zwraca wartość znacznika numerycznego skojarzonego z bieżącym
nagłówkiem. Jeśli nagłówek nie posiada takiego znacznika, zwracane
jest 0.
- Składnia
String_Type get_visible_headers ()
- Opis
Funkcja zwraca listę tych linii nagłówka, które będą wyświetlane przy
czytaniu artykułu. Format tego napisu podano przy opisie
set_visible_headers.
- Zobacz również
set_visible_headers, is_article_visible, set_header_display_format
- Składnia
Integer goto_num_tagged_header (Integer n)
- Opis
Wywołanie tej funkcji czyni bieżącym nagłówek ze znacznikiem
numerycznym podanym jako argument wywołania. Zwraca 1 w razie sukcesu, i 0
w przeciwnym przypadku.
- Zobacz również
header_down, get_header_flags, call
- Składnia
Integer header_down (Integer n)
- Opis
Funkcja przemieszcza bieżącą pozycję na liście o n nagłówków w dół.
Zwraca wartość rzeczywiście dokonanego przesunięcia.
- Zobacz również
header_up
- Składnia
Intger header_next_unread ()
- Opis
Wywołanie tej funkcji powoduje przejście do nagłówka następnej
nieprzeczytanej wiadomości. Zwraca 1 w razie sukcesu, 0 w przeciwnym
przypadku.
- Zobacz również
header_down
- Składnia
header_up ()
- Opis
Funkcja przemieszcza bieżącą pozycję na liście o n nagłówków do góry.
Zwraca wartość rzeczywiście dokonanego przesunięcia.
- Zobacz również
header_down
- Składnia
Int_Type headers_hidden_mode ()
- Opis
Funkcja ta pozwala określić, czy niektóre linie nagłówka będą ukryte
podczas wyświetlania treści artykułu. Zwraca 0, jeśli wszystkie linie
nagłówka będą wyświetlone, a wartość niezerową, jeśli niektóre mogą być
ukryte.
- Zobacz również
set_visible_headers, get_visible_headers, is_article_visible
- Składnia
Integer is_thread_collapsed ()
- Opis
Jeśli bieżący nagłówek rozpoczyna zwinięty wątek, funkcja ta zwraca
wartość niezerową. Jeśli wątek jest rozwinięty, zwraca 0.
- Zobacz również
collapse_thread
- Składnia
Int_Type locate_header_by_msgid (String_Type msgid, Int_Type qs)
- Opis
Funkcja ta pozwala na ustawienie bieżącego nagłówka według wartości
Message-Id podanej w argumencie msgid. Jeśli argument qs ma
wartość niezerową, żądany nagłówek zostanie w razie potrzeby pobrany z
serwera. Funkcja zwraca 1, jeśli znaleziono poszukiwany nagłówek, a 0 w
przeciwnym przypadku.
- Przykład
Jednym z możliwych zastosowań tej funkcji jest zaznaczenie bieżącej
pozycji na liście nagłówków i późniejszy powrót na tą pozycję:
% Zapamiętaj bieżącą pozycję
variable msgid = extract_article_header ("Message-Id");
.
.
% Wróć na zapamiętaną pozycję.
() = locate_header_by_msgid (msgid, 0);
- Składnia
Integer next_tagged_header ()
- Opis
Funkcja ta przesuwa pozycję bieżącego nagłówka do następnego
oznaczonego za pomocą flagi '*'. Zwraca wartość niezerową w razie
sukcesu, i zero w przeciwnym przypadku.
- Zobacz również
prev_tagged_header, goto_num_tagged_header, header_up, header_down
- Składnia
Integer prev_tagged_header ()
- Opis
Funkcja ta przesuwa pozycję bieżącego nagłówka do poprzedniego
oznaczonego za pomocą flagi '*'. Zwraca wartość niezerową w razie
sukcesu, i zero w przeciwnym przypadku.
- Zobacz również
next_tagged_header, goto_num_tagged_header, header_up, header_down
- Składnia
Integer re_bsearch_author (String regexp)
- Opis
Szuka wstecz nagłówka, dla którego nazwa autora pasuje do wyrażenia
regularnego podanego w argumencie regexp. W razie powodzenia
ustawia bieżący nagłówek na znaleziony i zwraca 1; w przeciwnym
przypadku zwraca 0.
- Zobacz również
re_fsearch_author, re_fsearch_subject
- Składnia
Integer re_bsearch_subject (String regexp)
- Opis
Szuka wstecz nagłówka, którego temat pasuje do wyrażenia regularnego
podanego w argumencie regexp. W razie powodzenia ustawia bieżący
nagłówek na znaleziony i zwraca 1; w przeciwnym przypadku zwraca 0.
- Zobacz również
re_fsearch_author, re_bsearch_subject
- Składnia
Integer re_bsearch_author (String regexp)
- Opis
Szuka w przód nagłówka, dla którego nazwa autora pasuje do wyrażenia
regularnego podanego w argumencie regexp. W razie powodzenia
ustawia bieżący nagłówek na znaleziony i zwraca 1; w przeciwnym
przypadku zwraca 0.
- Zobacz również
re_bsearch_author, re_fsearch_subject
- Składnia
Integer re_fsearch_subject (String regexp)
- Opis
Szuka w przód nagłówka, którego temat pasuje do wyrażenia
regularnego podanego w argumencie regexp. W razie powodzenia
ustawia bieżący nagłówek na znaleziony i zwraca 1; w przeciwnym
przypadku zwraca 0.
- Zobacz również
re_fsearch_author, re_bsearch_subject
- Składnia
Void set_header_display_format (Int_Type n, String_Type fmt)
- Opis
Funkcja ta może być użyta do ustawienia n-tego formatu wyświetlania
nagłówków według wartości podanej argumentem fmt. Między formatami
można przełączać się interakcyjnie za pomocą kombinacji klawiszy
przypisanej do toggle_header_formats.
Specyfikator formatu rozpoczyna się od znaku % i ma postać:
%[-][w]x
gdzie nawiasy kwadratowe oznaczają elementy opcjonalne. w jest jedno-
lub dwucyfrowym specyfikatorem szerokości pola. Jeśli użyto znaku minus,
pole będzie wyrównane do prawej, jeśli nie - do lewej. Specyfikator
x jest obowiązkowy i oznacza:
s : temat
S : punktacja
r : nazwa autora
f : adres autora
G : punktacja Group lens
l : liczba wierszy artykułu
n : numer artykułu na serwerze
d : data wysłania
t : drzewo wątku
F : flagi ([nie]przeczytany, znaczniki '*' i '#', numer nagłówka)
% : znak procenta
g : polecenie przejścia do podanej kolumny ekranu
Zatem: "%F%-5l:%t%s" oznacza, że okno nagłówków będzie zawierać
kolejno: flagi, liczbę wierszy artykułu wyrównaną do prawej strony w polu
o pięcioznakowej szerokości, znak ':', drzewo wątku i temat.
Specyfikator formatu g musi być poprzedzony liczbą oznaczającą
numer kolumny, w której rozpoczynać się będzie następny wpis. Jeśli
liczba ta jest ujemna, oznacza to odległość od prawej strony ekranu. Na
przykład %-24g%f oznacza, że nagłówek From ma być
wyprowadzony w miejscu odległym o 24 kolumny od prawej krawędzi ekranu.
- Zobacz również
set_visible_headers
- Składnia
Void set_header_flags (Integer flags)
- Opis
Funkcja ta pozwala na ustawienie flag skojarzonych z bieżącym
nagłówkiem. Szczegóły podano przy opisie funkcji get_header_flags.
- Zobacz również
get_header_flags
- Składnia
Void set_header_score (Integer score)
- Opis
Funkcja ta umożliwia ustawienie punktacji dla bieżącego nagłówka.
- Zobacz również
get_header_score
- Składnia
Void set_visible_headers (String_Type header_list)
- Opis
Funkcja ta umożliwia wyspecyfikowanie nagłówków, które mają być
pokazywane podczas wyświetlania artykułu. Argument header_list
podaje rozdzieloną przecinkami listę nagłówków do wyświetlenia.
- Przykład
W celu wyświetlenia tylko nagłówka "From", oraz tych, które zaczynają się
od "X-", należy użyć:
set_visible_headers ("X-,From:");
- Zobacz również
get_visible_headers, headers_hidden_mode, is_article_visible, set_header_display_format
- Składnia
Void sort_by_sorting_method ()
- Opis
Funkcja ta sortuje artykuły w oknie nagłówków według bieżącego trybu
sortowania.
- Przykład
Funkcja jest użyteczna, jeśli chcemy ujrzeć skutki zmiany wartości
zmiennej sorting_method:
set_integer_variable("sorting_method", 3);
sort_by_sorting_method ();
- Składnia
Integer thread_size ()
- Opis
Funkcja zwraca liczbę artykułów w bieżącym wątku lub podwątku.
- Składnia
Void uncollapse_thread ()
- Opis
Wywołanie tej funkcji powoduje rozwinięcie bieżącego wątku.
- Zobacz również
thread_size, collapse_thread, is_thread_collapsed
- Składnia
Void uncollapse_threads ()
- Opis
Wywołanie tej funkcji powoduje rozwinięcie wszystkich bieżącego wątków.
Jej użycie jest konieczne dla umożliwienia dostępu do ukrytych nagłówków
funkcjom przemieszczającym bieżącą pozycję na liście.
- Zobacz również
collapse_threads
Następna
Poprzednia
Spis treści
|
 |
Funkcje slrn
1. Funkcje obsługujące nagłówki i wątkowanie
2. Funkcje dostępne w trybie artykułów
3. Funkcje dostępne w trybie grup
4. Funkcje dialogowe i informacyjne
5. Interakcja z użytkownikiem
6. Obsługa plików
7. Inne funkcje
8. Funkcje obsługi zdarzeń (Hooks)
|
|
