StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

docs: Add docs to ContentDialog

Browse Source
This commit is contained in:
Diadlo 2017-03-04 23:35:42 +03:00
parent add8d51a29
commit 74356abda4
No known key found for this signature in database
GPG Key ID: 5AF9F2E29107C727
1 changed files with 97 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
src/widget/contentdialog.cpp
View File

@ -300,6 +300,13 @@ void ContentDialog::ensureSplitterVisible()
update();
}
/**
* @brief Get current layout and index of current wiget in it.
* Current layout -- layout contains activated widget.
*
* @param[out] layout Current layout
* @return Index of current widget in current layout.
*/
int ContentDialog::getCurrentLayout(QLayout*& layout)
{
layout = friendLayout->getLayoutOnline();
@ -324,6 +331,11 @@ int ContentDialog::getCurrentLayout(QLayout*& layout)
return -1;
}
/**
* @brief Activate next/previous contact.
* @param forward If true, activate next contace, previous otherwise.
* @param inverse ??? TODO: Add docs.
*/
void ContentDialog::cycleContacts(bool forward, bool inverse)
{
QLayout* currentLayout;
@ -434,6 +446,11 @@ void ContentDialog::updateFriendStatus(int friendId)
}
}
/**
* @brief Update friend status message.
* @param friendId Id friend, whose status was changed.
* @param message Status message.
*/
void ContentDialog::updateFriendStatusMessage(int friendId, const QString& message)
{
auto iter = friendList.find(friendId);
@ -470,6 +487,9 @@ ContentDialog* ContentDialog::getGroupDialog(int groupId)
return getDialog(groupId, groupList);
}
/**
* @brief Update window title and icon.
*/
void ContentDialog::updateTitleAndStatusIcon()
{
if (!activeChatroomWidget) {
@ -514,11 +534,18 @@ void ContentDialog::previousContact()
cycleContacts(false);
}
/**
* @brief Enable next contact.
*/
void ContentDialog::nextContact()
{
cycleContacts(true);
}
/**
* @brief Update username to show in the title.
* @param newName New name to display.
*/
void ContentDialog::setUsername(const QString& newName)
{
username = newName;
@ -665,6 +692,11 @@ void ContentDialog::keyPressEvent(QKeyEvent* event)
}
}
/**
* @brief Show ContentDialog, activate chatroom widget.
* @param widget Widget which was clicked.
* @param group Seems always `false`. TODO: Remove
*/
void ContentDialog::onChatroomWidgetClicked(GenericChatroomWidget* widget, bool group)
{
if (group) {
@ -706,6 +738,11 @@ void ContentDialog::onChatroomWidgetClicked(GenericChatroomWidget* widget, bool
updateTitleAndStatusIcon();
}
/**
* @brief Update friend widget name and position.
* @param friendId Friend Id.
* @param alias Alias to display on widget.
*/
void ContentDialog::updateFriendWidget(uint32_t friendId, QString alias)
{
Friend* f = FriendList::findFriend(friendId);
@ -717,6 +754,10 @@ void ContentDialog::updateFriendWidget(uint32_t friendId, QString alias)
friendLayout->addFriendWidget(friendWidget, status);
}
/**
* @brief Update group widget name and 'status'.
* @param w Group widget to update.
*/
void ContentDialog::updateGroupWidget(GroupWidget* w)
{
ContactInfo info = groupList.find(w->groupId).value();
@ -727,27 +768,49 @@ void ContentDialog::updateGroupWidget(GroupWidget* w)
widget->onUserListChanged();
}
/**
* @brief Handler of `groupchatPositionChanged` action.
* Move group layout on the top or on the buttom.
*
* @param top If true, move group layout on the top, false otherwise.
*/
void ContentDialog::onGroupchatPositionChanged(bool top)
{
friendLayout->removeItem(groupLayout.getLayout());
friendLayout->insertLayout(top ? 0 : 1, groupLayout.getLayout());
}
/**
* @brief Retranslate all elements in the form.
*/
void ContentDialog::retranslateUi()
{
updateTitleAndStatusIcon();
}
/**
* @brief Save size of dialog window.
*/
void ContentDialog::saveDialogGeometry()
{
Settings::getInstance().setDialogGeometry(saveGeometry());
}
/**
* @brief Save state of splitter between dialog and dialog list.
*/
void ContentDialog::saveSplitterState()
{
Settings::getInstance().setDialogSplitterState(splitter->saveState());
}
/**
* @brief Check if current ContentDialog instance and chatroom widget associated with user.
* @param id User Id.
* @param chatroomWidget Widget which should be a pair for current dialog.
* @param list List with contact info.
* @return True, if chatroomWidget is pair for current instance.
*/
bool ContentDialog::hasWidget(int id, GenericChatroomWidget* chatroomWidget,
const QHash<int, ContactInfo>& list)
{
@ -760,6 +823,11 @@ bool ContentDialog::hasWidget(int id, GenericChatroomWidget* chatroomWidget,
std::get<1>(*iter) == chatroomWidget;
}
/**
* @brief Focus the dialog if it exists.
* @param id User Id.
* @param list List with contact info.
*/
void ContentDialog::focusDialog(int id, const QHash<int, ContactInfo>& list)
{
auto iter = list.find(id);
@ -777,12 +845,23 @@ void ContentDialog::focusDialog(int id, const QHash<int, ContactInfo>& list)
dialog->onChatroomWidgetClicked(std::get<1>(iter.value()), false);
}
/**
* @brief Check, if widget is exists.
* @param id User Id.
* @param list List with contact info.
* @return True is widget exists, false otherwise.
*/
bool ContentDialog::existsWidget(int id, const QHash<int, ContactInfo>& list)
{
auto iter = list.find(id);
return iter != list.end();
}
/**
* @brief Update widget status and dialog title for current user.
* @param id User Id.
* @param list List with contact info.
*/
void ContentDialog::updateStatus(int id, const QHash<int, ContactInfo>& list)
{
auto iter = list.find(id);
@ -799,6 +878,12 @@ void ContentDialog::updateStatus(int id, const QHash<int, ContactInfo>& list)
}
}
/**
* @brief Check, if user dialog is active.
* @param id User Id.
* @param list List with contact info.
* @return True if user dialog is active, false otherwise.
*/
bool ContentDialog::isWidgetActive(int id, const QHash<int, ContactInfo>& list)
{
auto iter = list.find(id);
@ -809,6 +894,12 @@ bool ContentDialog::isWidgetActive(int id, const QHash<int, ContactInfo>& list)
return std::get<0>(iter.value())->activeChatroomWidget == std::get<1>(iter.value());
}
/**
* @brief Select ContentDialog by id from the list.
* @param id User Id.
* @param list List with contact info.
* @return ContentDialog for user and nullptr if not found.
*/
ContentDialog* ContentDialog::getDialog(int id, const QHash<int, ContactInfo>& list)
{
auto iter = list.find(id);
@ -819,6 +910,12 @@ ContentDialog* ContentDialog::getDialog(int id, const QHash<int, ContactInfo>& l
return std::get<0>(iter.value());
}
/**
* @brief Find the next or previous layout in layout list.
* @param layout Current layout.
* @param forward If true, move forward, backward othwerwise.
* @return Next/previous layout.
*/
QLayout* ContentDialog::nextLayout(QLayout* layout, bool forward) const
{
int index = layouts.indexOf(layout);