Dokumentacja klasy GUITabList

#include <GUITabList.h>

Lista wszystkich składowych.

Sloty publiczne
void	addTab (QHostAddress ip, QString name, bool can_be_closed, QString icon)
void	setUnactiveUser (QHostAddress host)
void	closeActiveTab ()
Sygnały
void	tabCanNotBeClose ()
void	tabCanBeClose ()
void	isOnline ()
void	isNotOnline ()
void	setDisableInputText ()
Metody publiczne
	GUITabList (QWidget *parent, QHostAddress broadcast, QString sm="red", QString um="green", QString bc="white")
void	delTab (QHostAddress ip)
void	hideTab (QHostAddress ip)
void	showTab (QHostAddress ip)
void	setActiveTab (QHostAddress ip)
GUITab *	getActiveTab ()
GUITab *	publicChat ()
GUITab *	tab (int index)
void	closeTab (GUITab *tab)
void	closeAllPrivChat ()
int	isCreate (QHostAddress ip)
int	getTabNumber (QHostAddress ip)
void	setTabTextColor (int index, QColor col="red")
Sloty prywatne
void	checkCBC (int index)
void	checkOnline (int index)
void	setDefaultIconAndColor (int index)
Atrybuty prywatne
QString	um
QString	sm
QString	bc

---

Opis szczegółowy

Klasa przechowuje liste zakładek. Odpowiada za ich zarzšdzanie, kolorowanie, zmienianie ikon

Definicja w linii 14 pliku GUITabList.h.

---

Dokumentacja konstruktora i destruktora

GUITabList::GUITabList (  QWidget *  parent, QHostAddress  broadcast, QString  sm = "red", QString  um = "green", QString  bc = "white" )

Definicja w linii 6 pliku GUITabList.cpp. Odwołuje się do addTab(), checkCBC(), checkOnline() i setDefaultIconAndColor().

---

Dokumentacja funkcji składowych

void GUITabList::addTab (  QHostAddress  ip, QString  name, bool  can_be_closed, QString  icon )  [slot]

Dodaje zkładkę. Jeżeli zakładka nie istnieje tworzy nowš zakładkę i ustawia jš jako aktywnš. Jeżeli istnieje nie tworzy następnej tylko ustawia jš jko aktywnš. Parametry: ip  Adres ip rozmówcy dla którego została utworzona zakładka. name  Tytuł zakładki. can_be_close  Czy zakładka może być zamknięta. icon  ikonka zakładki Definicja w linii 26 pliku GUITabList.cpp. Odwołuje się do bc, isCreate(), setActiveTab(), sm i um. Odwołania w GUITabList(), GUIMainWindow::privateChat() i GUIMainWindow::recvPMsg().

void GUITabList::checkCBC (  int  index  )  [private, slot]

SprawdŸ czy zakładka może być zamknięta. Sprawdza czy zakładka o podanym indeksie może być zamknięta. Jeżeli tak emituje sygnał tabCanBeClose(), w przeciwnym razie emituje sygnał tabCanNotBeClose() Parametry: index  numer zakładki która sprawdzić Definicja w linii 121 pliku GUITabList.cpp. Odwołuje się do tabCanNotBeClose(). Odwołania w GUITabList().

void GUITabList::checkOnline (  int  index  )  [private, slot]

SprawdŸ czy rozmówca jest online. Sprawdza czy zakładka o podanym indeksie ma ustawionš flagę onLine na true. Jeżeli tak emituje sygnał isOnline(), w przeciwnym razie emituje sygnał isNotOnline() Parametry: index  numer zakładki która sprawdzić Definicja w linii 133 pliku GUITabList.cpp. Odwołuje się do isNotOnline(). Odwołania w GUITabList().

void GUITabList::closeActiveTab (   )  [slot]

Zamyka aktywnš zakładkę. Uwaga! metoda nie sprawdza flagi can_be_close zamykanej zakładki Definicja w linii 103 pliku GUITabList.cpp. Odwołuje się do closeTab() i getActiveTab().

void GUITabList::closeAllPrivChat (   )

Ustawia zakładki offline. Ustawia wszystkie zakładki z rozmowami prywatnymi na offline. Używane przy rozłšczaniu programu Definicja w linii 157 pliku GUITabList.cpp. Odwołuje się do GUITab::setOnline() i tab(). Odwołania w GUIMainWindow::disconnectChat(). Oto graf wywołań dla tej funkcji:

void GUITabList::closeTab (  GUITab *  tab  )

Zamknij zakładkę. Parametry: tab  wskaŸnik na zakładkę która ma być zamknięta Definicja w linii 82 pliku GUITabList.cpp. Odwołuje się do GUITab::getCBC(), GUITab::getIp() i tab(). Odwołania w closeActiveTab(). Oto graf wywołań dla tej funkcji:

void GUITabList::delTab (  QHostAddress  ip  )

Usuń zakładkę. Usuwa zakładkę o podanym adresie IP. Parametry: ip  adres ip w zakładce która ma być zamknięta Definicja w linii 41 pliku GUITabList.cpp.

GUITab * GUITabList::getActiveTab (   )

Zwraca aktywnš zakładkę. Zwraca: Zwraca wskaŸnik na aktywnš zakładkę. Definicja w linii 67 pliku GUITabList.cpp. Odwołania w GUIMainWindow::cancelFileTransfer(), GUIMainWindow::checkIp(), GUIMainWindow::checkPing(), GUIMainWindow::clearActiveChatPage(), closeActiveTab(), GUIMainWindow::incomingFile(), GUIMainWindow::pong(), GUIMainWindow::recvPMsg(), GUIMainWindow::sendFile(), GUIMainWindow::sendMsg() i GUIMainWindow::transferEnd().

int GUITabList::getTabNumber (  QHostAddress  ip  )

Zwraca nr zakładki o podanym adresie ip. Parametry: ip  szukany adres ip Zwraca: numer zakładki Definicja w linii 108 pliku GUITabList.cpp. Odwołuje się do isCreate(). Odwołania w GUIMainWindow::recvPMsg(), setActiveTab(), setUnactiveUser() i GUIMainWindow::setUserOnline(). Oto graf wywołań dla tej funkcji:

void GUITabList::hideTab (  QHostAddress  ip  )

Ukrywa zakładkę. Ukrywa zakładkę o podanym adresie IP. Parametry: ip  adres ip w zakładce która ma być ukryta Definicja w linii 47 pliku GUITabList.cpp.

int GUITabList::isCreate (  QHostAddress  ip  )

Czy istnieje zakładka. Sprawdza czy istnieje na liœcie zakładka o podanym adresie IP Parametry: ip  szukany adres ip Zwraca: 0 jeœli nie istnieje, w przeciwnym razie numer zakładki Definicja w linii 90 pliku GUITabList.cpp. Odwołania w addTab(), getTabNumber(), GUIMainWindow::recvPMsg(), setUnactiveUser() i GUIMainWindow::setUserOnline().

void GUITabList::isNotOnline (   )  [signal]

Rozmówca offline. Sygnał wysyłany gdy aktualna zakładka ma ustawione pole onLine na true Odwołania w checkOnline().

void GUITabList::isOnline (   )  [signal]

Rozmówca online. Sygnał wysyłany gdy aktualna zakładka ma ustawione pole onLine na true

GUITab * GUITabList::publicChat (   )

Zwraca zakładkę rozmów publicznych. Zwraca: Zwraca wskaŸnik na zakładkę z rozmowami publicznymi. Definicja w linii 72 pliku GUITabList.cpp. Odwołuje się do tab(). Odwołania w GUIMainWindow::acceptSendFile(), GUIMainWindow::connectChat(), GUIMainWindow::connected(), GUIMainWindow::disconnectChat(), GUIMainWindow::recvBMsg() i GUIMainWindow::unableConnect(). Oto graf wywołań dla tej funkcji:

void GUITabList::setActiveTab (  QHostAddress  ip  )

Ustawia aktywnš zakładkę. Ustawia aktywnš zakładkę o podanym adresie IP. Parametry: ip  adres ip w zakładce która ma być ustawiona jako aktywna Definicja w linii 57 pliku GUITabList.cpp. Odwołuje się do getTabNumber(). Odwołania w addTab(). Oto graf wywołań dla tej funkcji:

void GUITabList::setDefaultIconAndColor (  int  index  )  [private, slot]

Definicja w linii 167 pliku GUITabList.cpp. Odwołuje się do tab(). Odwołania w GUITabList().

void GUITabList::setDisableInputText (   )  [signal]

Wyłšcz ChatInputText. Sygnał mowišcy, że należy dezaktywować pole do wprowadzanie treœci rozmowy Odwołania w setUnactiveUser().

void GUITabList::setTabTextColor (  int  index, QColor  col = "red" )

Ustawia kolor tytułu zakładki. Ustawia kolor textu który jest tytułem zakładki. Parametry: index  numer zakładki col  color na który ustawić, domyœlnie czerowny Definicja w linii 21 pliku GUITabList.cpp. Odwołania w GUIMainWindow::recvBMsg(), GUIMainWindow::recvPMsg(), setUnactiveUser() i GUIMainWindow::setUserOnline().

void GUITabList::setUnactiveUser (  QHostAddress  host  )  [slot]

Ustawia zakładkę na nieaktywnš. Jeżeli rozmawialiœmy z osobš o podanym adresie ip ustawia zakładkę rozmówcy jako offline. Nie możliwe jest dalsze wysyłanie wiadomoœci. Parametry: host  adres ip użytkownika z ktorym straciliœmy połaczenie. Definicja w linii 146 pliku GUITabList.cpp. Odwołuje się do getTabNumber(), isCreate(), setDisableInputText(), GUITab::setOnline(), setTabTextColor() i tab().

void GUITabList::showTab (  QHostAddress  ip  )

Pokazuje zakładkę. Pokazuje zakładkę o podanym adresie IP jeżeli wczeœniej była ukryta. Parametry: ip  adres ip w zakładce która ma być pokazana Definicja w linii 52 pliku GUITabList.cpp.

GUITab * GUITabList::tab (  int  index  )

Zwraca zakładkę o podanym indeksie. Parametry: index  nr zakładki do której ma być zwrócony wskaŸnik Zwraca: Zwraca wskaŸnik na zakładkę o podanym indeksie. Definicja w linii 77 pliku GUITabList.cpp. Odwołania w closeAllPrivChat(), closeTab(), publicChat(), GUIMainWindow::recvPMsg(), setDefaultIconAndColor(), setUnactiveUser() i GUIMainWindow::setUserOnline().

void GUITabList::tabCanBeClose (   )  [signal]

Można zamknšć zakładki. Sygnał wysyłany gdy zakładka ma ustawione pole can_be_close na true

void GUITabList::tabCanNotBeClose (   )  [signal]

Nie można zamknšć zakładki. Sygnał wysyłany gdy zakładka ma ustawione pole can_be_close na false Odwołania w checkCBC().

---

Dokumentacja atrybutów składowych

QString GUITabList::bc [private]

Definicja w linii 187 pliku GUITabList.h. Odwołania w addTab().

QString GUITabList::sm [private]

Definicja w linii 187 pliku GUITabList.h. Odwołania w addTab().

QString GUITabList::um [private]

Definicja w linii 187 pliku GUITabList.h. Odwołania w addTab().

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• GUITabList.h
• GUITabList.cpp

---