mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-07-14 22:42:14 -07:00
Reorder the structure.
Took 15 minutes
This commit is contained in:
Lukas Brübach
parent
fca212760e
commit
ad95682912
1 changed files with 412 additions and 404 deletions
|
|
@ -19,91 +19,390 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* ------------------------------------------------------------------ */
|
/* ------------------------------------------------------------------ */
|
||||||
/* Networking */
|
/* UI */
|
||||||
/* ------------------------------------------------------------------ */
|
/* ------------------------------------------------------------------ */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup Network Networking
|
* @defgroup UI User Interface
|
||||||
* @brief Networking components for client/server communication.
|
* @brief Graphical interface components built with Qt.
|
||||||
*
|
*
|
||||||
* Contains all systems related to communication between client and server.
|
* Includes high-level widgets, dialogs, models, and editors that form
|
||||||
* This includes lobby and room management, server interaction logic, and
|
* the interactive frontend of Cockatrice.
|
||||||
* message handling infrastructure based on protobuf.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup ApiInterfaces API Interfaces
|
* @defgroup Widgets Widgets
|
||||||
* @ingroup Client
|
* @ingroup UI
|
||||||
* @ingroup Parsing
|
* @brief General-purpose Qt widgets.
|
||||||
* @ingroup ImportExport
|
*
|
||||||
* @brief Interfaces for interacting with various APIs
|
* A collection of reusable widgets used throughout the application,
|
||||||
|
* such as CardInfoPictureFoilWidget, DeckAnalyticsWidget, and others.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup Dialogs Dialogs
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @brief Application dialogs.
|
||||||
|
*
|
||||||
|
* Includes dialogs for card prices, deck import/export,
|
||||||
|
* settings, and other modal user interactions.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup NetworkDialogs Networking Dialogs
|
||||||
|
* @ingroup Dialogs
|
||||||
|
* @ingroup NetworkingWidgets
|
||||||
|
* @brief Dialogs related to a RemoteClient interacting with a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup ClientUpdateDialogs Client Update Dialogs
|
||||||
|
* @ingroup NetworkDialogs
|
||||||
|
* @brief Dialogs relating to the client updating.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardDatabaseUpdateDialogs Card Database Update Dialogs
|
||||||
|
* @ingroup NetworkDialogs
|
||||||
|
* @ingroup CardDatabaseWidgets
|
||||||
|
* @brief Dialogs relating to the CardDatabase updating.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup ConnectionDialogs Connection Dialogs
|
||||||
|
* @ingroup NetworkDialogs
|
||||||
|
* @brief Dialogs relating to the RemoteClient%s connection to a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup AccountDialogs Account Dialogs
|
||||||
|
* @ingroup NetworkDialogs
|
||||||
|
* @brief Dialogs relating to account information on a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup RoomDialogs
|
||||||
|
* @ingroup NetworkDialogs
|
||||||
|
* @brief Dialogs relating to a RemoteClient interacting with a Room on a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup ServerLogDialogs Server Log Dialogs
|
||||||
|
* @ingroup NetworkDialogs
|
||||||
|
* @brief Dialogs relating to a RemoteClient interacting a RemoteServer%'s logs.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup Tabs Tabs
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @brief Tabbed UI components.
|
||||||
|
*
|
||||||
|
* Provides tab-based interfaces for organizing and navigating
|
||||||
|
* between multiple views in the application.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckEditorTabs Deck Editor Tabs
|
||||||
|
* @ingroup Tabs
|
||||||
|
* @ingroup DeckEditors
|
||||||
|
* @brief Tabs for the Deck Editors
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup NetworkingTabs Networking Tabs
|
||||||
|
* @ingroup Tabs
|
||||||
|
* @ingroup NetworkingWidgets
|
||||||
|
* @brief Tabs related to a RemoteClient interacting with a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup ServerTabs Server Tabs
|
||||||
|
* @ingroup NetworkingTabs
|
||||||
|
* @brief Tabs related to a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup AccountTabs Account Tabs
|
||||||
|
* @ingroup NetworkingTabs
|
||||||
|
* @brief Tabs related to user account information.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup RoomTabs Room Tabs
|
||||||
|
* @ingroup NetworkingTabs
|
||||||
|
* @ingroup RoomWidgets
|
||||||
|
* @brief Tabs related to a Room on a RemoteServer.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup MessagingTabs Message Tabs
|
||||||
|
* @ingroup NetworkingTabs
|
||||||
|
* @brief Tabs related to users sending messages to each other.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup PictureLoader Card Picture Loader
|
||||||
|
* @ingroup UI
|
||||||
|
* @ingroup Cards
|
||||||
|
* @brief The PictureLoader for CardInfoPictureWidget%s and CardItem%s
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------------ */
|
||||||
|
/* Cards */
|
||||||
|
/* ------------------------------------------------------------------ */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup Cards Cards
|
||||||
|
* @brief Representation of individual cards and their state.
|
||||||
|
*
|
||||||
|
* Defines card objects, attributes, metadata, and runtime state within
|
||||||
|
* both the database and the game engine.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardSets Card Sets
|
||||||
|
* @ingroup Cards
|
||||||
|
* @brief Card sets.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardPrintings Card Printings
|
||||||
|
* @ingroup Cards
|
||||||
|
* @brief Information about specific printings of cards.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardWidgets Card Widgets
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @ingroup Cards
|
||||||
|
* @brief Widgets for card display and interaction.
|
||||||
|
*
|
||||||
|
* Provides UI components that render individual cards, handle
|
||||||
|
* interactions, and display card details within the application.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardExtraInfoWidgets Card Extra Info Widgets
|
||||||
|
* @ingroup CardWidgets
|
||||||
|
* @brief Widgets for extended card information.
|
||||||
|
*
|
||||||
|
* Displays additional data associated with cards or data in a different form.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardDatabase Card Database
|
||||||
|
* @ingroup Cards
|
||||||
|
* @brief Core card database and loaders.
|
||||||
|
*
|
||||||
|
* Provides the underlying data models for cards, including loading,
|
||||||
|
* parsing, and managing the complete card database used in the application.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardDatabaseModels Models
|
||||||
|
* @ingroup CardDatabase
|
||||||
|
* @brief Qt models for card database access.
|
||||||
|
*
|
||||||
|
* Supplies Qt model abstractions for presenting card data in views,
|
||||||
|
* supporting filtering, sorting, and data binding to widgets.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardDatabaseModelFilters Filters
|
||||||
|
* @ingroup CardDatabaseModels
|
||||||
|
* @brief Filters for card database models.
|
||||||
|
*
|
||||||
|
* Provides reusable filtering components for Qt models, enabling
|
||||||
|
* refined queries and customized card data views.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardDatabaseParsers Parsers
|
||||||
|
* @ingroup CardDatabase
|
||||||
|
* @brief Parsers for card data.
|
||||||
|
*
|
||||||
|
* Implements parsers for card database structures, handling the
|
||||||
|
* transformation of raw data into structured objects and models.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup CardDatabaseWidgets Card Database Widgets
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @ingroup CardDatabase
|
||||||
|
* @brief Widgets for browsing and selecting cards.
|
||||||
|
*
|
||||||
|
* Provides UI components for interacting with the card database,
|
||||||
|
* including search, filtering, and browsing in tabular or list views.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup VisualCardDatabaseWidgets Visual Card Database Widgets
|
||||||
|
* @ingroup CardDatabaseWidgets
|
||||||
|
* @brief VisualDatabaseDisplayWidget and related helper classes.
|
||||||
|
*
|
||||||
|
* Enhances card browsing with graphical interfaces, offering
|
||||||
|
* image-based and grid-based views for selecting cards.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------------ */
|
||||||
|
/* Decks */
|
||||||
|
/* ------------------------------------------------------------------ */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup Decks Deck Management
|
||||||
|
* @brief DeckList handling, persistence, and tooling.
|
||||||
|
*
|
||||||
|
* Covers the lifecycle of decks: loading, saving, editing, import/export,
|
||||||
|
* and long-term persistence, including both textual and visual editors.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckModels Deck Models
|
||||||
|
* @ingroup Decks
|
||||||
|
* @brief Qt Models relating to DeckList.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckEditors Deck Editors
|
||||||
|
* @ingroup Decks
|
||||||
|
* @brief Editors for creating and modifying a DeckList.
|
||||||
|
*
|
||||||
|
* Provides visual and textual editors for building, modifying,
|
||||||
|
* and analyzing decks. Includes support for card search,
|
||||||
|
* sorting, and filtering of deck contents.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckEditorWidgets Deck Editor Widgets
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @ingroup DeckEditors
|
||||||
|
* @brief Supporting widgets for deck editors.
|
||||||
|
*
|
||||||
|
* Contains specialized UI components that extend deck editors with
|
||||||
|
* interactive functionality, data views, and user interaction tools.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckEditorTabs Deck Editor Tabs
|
||||||
|
* @ingroup DeckEditorWidgets
|
||||||
|
* @brief Tabs which implement AbstractTabDeckEditor to provide deck editing functionality.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckEditorAnalyticsWidgets Deck Editor Analytics Widgets
|
||||||
|
* @ingroup DeckEditorWidgets
|
||||||
|
* @brief Widgets for analyzing a DeckList.
|
||||||
|
*
|
||||||
|
* Provides visualization and statistical tools for analyzing decks.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckEditorCardGroupWidgets Card Group Display Widgets
|
||||||
|
* @ingroup DeckEditorWidgets
|
||||||
|
* @brief Widgets for displaying groups of cards.
|
||||||
|
*
|
||||||
|
* Provides interactive views that organize and display cards in groups,
|
||||||
|
* enabling filtering, sorting, and direct manipulation of deck sections.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup PrintingWidgets Printing Widgets
|
||||||
|
* @ingroup DeckEditorWidgets
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @brief Widgets for handling PrintingInfo of cards in a DeckList.
|
||||||
|
*
|
||||||
|
* Manages the display and editing of card printing information within a DeckList,
|
||||||
|
* including editions, variations, and preferences.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup DeckStorage Deck Storage
|
||||||
|
* @ingroup Decks
|
||||||
|
* @brief Systems for storing a DeckList on a local file system or remote service.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup LocalDeckStorage Local Deck Storage
|
||||||
|
* @ingroup DeckStorage
|
||||||
|
* @brief Systems for storing a DeckList on a local file system.
|
||||||
|
*
|
||||||
|
* Handles the persistence of a DeckList, providing file-based storage,
|
||||||
|
* metadata tracking, and tagging functionality.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup LocalDeckStorageWidgets Local Deck Storage Widgets
|
||||||
|
* @ingroup Widgets
|
||||||
|
* @ingroup LocalDeckStorage
|
||||||
|
* @brief Widgets for browsing and managing stored DeckLists.
|
||||||
|
*
|
||||||
|
* Provides list and tree-based views for exploring stored DeckLists,
|
||||||
|
* including tagging, searching, and preview functionality.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup ApiResponses API Responses
|
* @defgroup LocalDeckStorageDialogs Local Deck Storage Dialogs
|
||||||
* @ingroup ApiInterfaces
|
* @ingroup LocalDeckStorageWidgets
|
||||||
* @brief Structures representing API responses.
|
* @ingroup ImportExport
|
||||||
*
|
* @ingroup Lobby
|
||||||
* Encapsulates the data models for networking API responses,
|
* @brief Dialogs related to interacting with decks on a filesystem or in a remote location.
|
||||||
* providing consistent interfaces for parsing and handling results.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup ApiResponseDisplayWidgets API Response Display Widgets
|
* @defgroup VisualDeckStorageWidgets Visual Deck Storage Widgets
|
||||||
|
* @ingroup LocalDeckStorageWidgets
|
||||||
|
* @brief Visual widgets for DeckList storage.
|
||||||
|
*
|
||||||
|
* Offers graphical interfaces for browsing and interacting with a stored
|
||||||
|
* DeckList and tags, focusing on a more visual browsing experience.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup VisualDeckPreviewWidgets Visual Deck Preview Widgets
|
||||||
|
* @ingroup VisualDeckStorageWidgets
|
||||||
|
* @brief Widgets for visually previewing a DeckList.
|
||||||
|
*
|
||||||
|
* Provides visual previews of a DeckList, allowing users
|
||||||
|
* to inspect the deck name, color identity, and banner card at a glance.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup RemoteDeckStorage Remote Deck Storage
|
||||||
|
* @ingroup DeckStorage
|
||||||
|
* @brief Systems for storing a DeckList on a remote service.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup RemoteDeckStorageWidgets Remote Deck Storage Widgets
|
||||||
* @ingroup Widgets
|
* @ingroup Widgets
|
||||||
* @ingroup ApiResponses
|
* @ingroup RemoteDeckStorage
|
||||||
* @brief Qt widgets for displaying API responses.
|
* @ingroup ImportExport
|
||||||
|
* @ingroup Lobby
|
||||||
|
* @brief Widgets related to interacting with decks on a filesystem or in a remote location.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup RemoteDeckStorageDialogs Remote Deck Storage Dialogs
|
||||||
|
* @ingroup RemoteDeckStorageWidgets
|
||||||
|
* @brief Dialogs related to interacting with decks on a filesystem or in a remote location.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup ImportExport Import/Export
|
||||||
|
* @ingroup DeckStorage
|
||||||
|
* @brief DeckList import, export, and conversion.
|
||||||
*
|
*
|
||||||
* Provides user interface components that render and present API response
|
* Supports importing and exporting a DeckList across formats, including
|
||||||
* data to the user in a structured and interactive way.
|
* text, Cockatrice-native formats, and third-party platforms.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup Messages Protocol Messages
|
* @defgroup Parsing Parsing
|
||||||
* @ingroup Network
|
* @ingroup DeckStorage
|
||||||
* @brief Protocol message definitions and handlers.
|
* @brief Deck parsing and external API integration.
|
||||||
*
|
*
|
||||||
* Contains the generated protobuf messages and supporting code used
|
* Contains parsers for deck URLs and APIs (e.g., TappedOut, Archidekt,
|
||||||
* to encode, decode, and process communication between client and server.
|
* Moxfield, Deckstats), allowing seamless import and synchronization.
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup Client Client
|
|
||||||
* @ingroup Network
|
|
||||||
* @brief The Cockatrice client application.
|
|
||||||
*
|
|
||||||
* Handles all client-side communication with the server.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup NetworkingWidgets Networking Widgets
|
|
||||||
* @ingroup Widgets
|
|
||||||
* @ingroup Client
|
|
||||||
* @brief Widgets related to a RemoteClient interacting with a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup ClientUpdates Client Updates
|
|
||||||
* @ingroup Client
|
|
||||||
* @brief Client updates.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup Server Server
|
|
||||||
* @ingroup Network
|
|
||||||
* @brief The Cockatrice server application.
|
|
||||||
*
|
|
||||||
* Provides the authoritative game backend, handling authentication,
|
|
||||||
* lobbies, game rooms, and relaying state between connected clients.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup RoomWidgets Room Widgets
|
|
||||||
* @ingroup Widgets
|
|
||||||
* @ingroup Client
|
|
||||||
* @brief Server room management.
|
|
||||||
*
|
|
||||||
* Manages creation and interaction of Game lobbies and room state synchronization with the server.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* ------------------------------------------------------------------ */
|
/* ------------------------------------------------------------------ */
|
||||||
|
|
@ -262,384 +561,93 @@
|
||||||
* including event handling and triggered effects.
|
* including event handling and triggered effects.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
/* ------------------------------------------------------------------ */
|
/* ------------------------------------------------------------------ */
|
||||||
/* Decks */
|
/* Networking */
|
||||||
/* ------------------------------------------------------------------ */
|
/* ------------------------------------------------------------------ */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup Decks Deck Management
|
* @defgroup Network Networking
|
||||||
* @brief DeckList handling, persistence, and tooling.
|
* @brief Networking components for client/server communication.
|
||||||
*
|
*
|
||||||
* Covers the lifecycle of decks: loading, saving, editing, import/export,
|
* Contains all systems related to communication between client and server.
|
||||||
* and long-term persistence, including both textual and visual editors.
|
* This includes lobby and room management, server interaction logic, and
|
||||||
|
* message handling infrastructure based on protobuf.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup DeckModels Deck Models
|
* @defgroup ApiInterfaces API Interfaces
|
||||||
* @ingroup Decks
|
* @ingroup Client
|
||||||
* @brief Qt Models relating to DeckList.
|
* @ingroup Parsing
|
||||||
*/
|
* @ingroup ImportExport
|
||||||
|
* @brief Interfaces for interacting with various APIs
|
||||||
/**
|
|
||||||
* @defgroup DeckEditors Deck Editors
|
|
||||||
* @ingroup Decks
|
|
||||||
* @brief Editors for creating and modifying a DeckList.
|
|
||||||
*
|
|
||||||
* Provides visual and textual editors for building, modifying,
|
|
||||||
* and analyzing decks. Includes support for card search,
|
|
||||||
* sorting, and filtering of deck contents.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup DeckEditorWidgets Deck Editor Widgets
|
|
||||||
* @ingroup Widgets
|
|
||||||
* @ingroup DeckEditors
|
|
||||||
* @brief Supporting widgets for deck editors.
|
|
||||||
*
|
|
||||||
* Contains specialized UI components that extend deck editors with
|
|
||||||
* interactive functionality, data views, and user interaction tools.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup DeckEditorAnalyticsWidgets Deck Editor Analytics Widgets
|
|
||||||
* @ingroup DeckEditorWidgets
|
|
||||||
* @brief Widgets for analyzing a DeckList.
|
|
||||||
*
|
|
||||||
* Provides visualization and statistical tools for analyzing decks.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup DeckEditorCardGroupWidgets Card Group Display Widgets
|
|
||||||
* @ingroup DeckEditorWidgets
|
|
||||||
* @brief Widgets for displaying groups of cards.
|
|
||||||
*
|
|
||||||
* Provides interactive views that organize and display cards in groups,
|
|
||||||
* enabling filtering, sorting, and direct manipulation of deck sections.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup PrintingWidgets Printing Widgets
|
|
||||||
* @ingroup DeckEditorWidgets
|
|
||||||
* @ingroup Widgets
|
|
||||||
* @brief Widgets for handling PrintingInfo of cards in a DeckList.
|
|
||||||
*
|
|
||||||
* Manages the display and editing of card printing information within a DeckList,
|
|
||||||
* including editions, variations, and preferences.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup DeckStorage Deck Storage
|
|
||||||
* @ingroup Decks
|
|
||||||
* @brief Systems for storing a DeckList on a local file system or remote service.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup LocalDeckStorage Local Deck Storage
|
|
||||||
* @ingroup DeckStorage
|
|
||||||
* @brief Systems for storing a DeckList on a local file system.
|
|
||||||
*
|
|
||||||
* Handles the persistence of a DeckList, providing file-based storage,
|
|
||||||
* metadata tracking, and tagging functionality.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup LocalDeckStorageWidgets Local Deck Storage Widgets
|
|
||||||
* @ingroup Widgets
|
|
||||||
* @ingroup LocalDeckStorage
|
|
||||||
* @brief Widgets for browsing and managing stored DeckLists.
|
|
||||||
*
|
|
||||||
* Provides list and tree-based views for exploring stored DeckLists,
|
|
||||||
* including tagging, searching, and preview functionality.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup LocalDeckStorageDialogs Local Deck Storage Dialogs
|
* @defgroup ApiResponses API Responses
|
||||||
* @ingroup LocalDeckStorageWidgets
|
* @ingroup ApiInterfaces
|
||||||
* @ingroup ImportExport
|
* @brief Structures representing API responses.
|
||||||
* @ingroup Lobby
|
*
|
||||||
* @brief Dialogs related to interacting with decks on a filesystem or in a remote location.
|
* Encapsulates the data models for networking API responses,
|
||||||
|
* providing consistent interfaces for parsing and handling results.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup VisualDeckStorageWidgets Visual Deck Storage Widgets
|
* @defgroup ApiResponseDisplayWidgets API Response Display Widgets
|
||||||
* @ingroup LocalDeckStorageWidgets
|
|
||||||
* @brief Visual widgets for DeckList storage.
|
|
||||||
*
|
|
||||||
* Offers graphical interfaces for browsing and interacting with a stored
|
|
||||||
* DeckList and tags, focusing on a more visual browsing experience.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup VisualDeckPreviewWidgets Visual Deck Preview Widgets
|
|
||||||
* @ingroup VisualDeckStorageWidgets
|
|
||||||
* @brief Widgets for visually previewing a DeckList.
|
|
||||||
*
|
|
||||||
* Provides visual previews of a DeckList, allowing users
|
|
||||||
* to inspect the deck name, color identity, and banner card at a glance.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup RemoteDeckStorage Remote Deck Storage
|
|
||||||
* @ingroup DeckStorage
|
|
||||||
* @brief Systems for storing a DeckList on a remote service.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup RemoteDeckStorageWidgets Remote Deck Storage Widgets
|
|
||||||
* @ingroup Widgets
|
* @ingroup Widgets
|
||||||
* @ingroup RemoteDeckStorage
|
* @ingroup ApiResponses
|
||||||
* @ingroup ImportExport
|
* @brief Qt widgets for displaying API responses.
|
||||||
* @ingroup Lobby
|
|
||||||
* @brief Widgets related to interacting with decks on a filesystem or in a remote location.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup RemoteDeckStorageDialogs Remote Deck Storage Dialogs
|
|
||||||
* @ingroup RemoteDeckStorageWidgets
|
|
||||||
* @brief Dialogs related to interacting with decks on a filesystem or in a remote location.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup ImportExport Import/Export
|
|
||||||
* @ingroup DeckStorage
|
|
||||||
* @brief DeckList import, export, and conversion.
|
|
||||||
*
|
*
|
||||||
* Supports importing and exporting a DeckList across formats, including
|
* Provides user interface components that render and present API response
|
||||||
* text, Cockatrice-native formats, and third-party platforms.
|
* data to the user in a structured and interactive way.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup Parsing Parsing
|
* @defgroup Messages Protocol Messages
|
||||||
* @ingroup DeckStorage
|
* @ingroup Network
|
||||||
* @brief Deck parsing and external API integration.
|
* @brief Protocol message definitions and handlers.
|
||||||
*
|
*
|
||||||
* Contains parsers for deck URLs and APIs (e.g., TappedOut, Archidekt,
|
* Contains the generated protobuf messages and supporting code used
|
||||||
* Moxfield, Deckstats), allowing seamless import and synchronization.
|
* to encode, decode, and process communication between client and server.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* ------------------------------------------------------------------ */
|
|
||||||
/* Cards */
|
|
||||||
/* ------------------------------------------------------------------ */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup Cards Cards
|
* @defgroup Client Client
|
||||||
* @brief Representation of individual cards and their state.
|
* @ingroup Network
|
||||||
|
* @brief The Cockatrice client application.
|
||||||
*
|
*
|
||||||
* Defines card objects, attributes, metadata, and runtime state within
|
* Handles all client-side communication with the server.
|
||||||
* both the database and the game engine.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup CardSets Card Sets
|
* @defgroup NetworkingWidgets Networking Widgets
|
||||||
* @ingroup Cards
|
|
||||||
* @brief Card sets.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup CardPrintings Card Printings
|
|
||||||
* @ingroup Cards
|
|
||||||
* @brief Information about specific printings of cards.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup CardWidgets Card Widgets
|
|
||||||
* @ingroup Widgets
|
* @ingroup Widgets
|
||||||
* @ingroup Cards
|
* @ingroup Client
|
||||||
* @brief Widgets for card display and interaction.
|
* @brief Widgets related to a RemoteClient interacting with a RemoteServer.
|
||||||
*
|
|
||||||
* Provides UI components that render individual cards, handle
|
|
||||||
* interactions, and display card details within the application.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup CardExtraInfoWidgets Card Extra Info Widgets
|
* @defgroup ClientUpdates Client Updates
|
||||||
* @ingroup CardWidgets
|
* @ingroup Client
|
||||||
* @brief Widgets for extended card information.
|
* @brief Client updates.
|
||||||
*
|
|
||||||
* Displays additional data associated with cards or data in a different form.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup CardDatabase Card Database
|
* @defgroup Server Server
|
||||||
* @ingroup Cards
|
* @ingroup Network
|
||||||
* @brief Core card database and loaders.
|
* @brief The Cockatrice server application.
|
||||||
*
|
*
|
||||||
* Provides the underlying data models for cards, including loading,
|
* Provides the authoritative game backend, handling authentication,
|
||||||
* parsing, and managing the complete card database used in the application.
|
* lobbies, game rooms, and relaying state between connected clients.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup CardDatabaseModels Models
|
* @defgroup RoomWidgets Room Widgets
|
||||||
* @ingroup CardDatabase
|
|
||||||
* @brief Qt models for card database access.
|
|
||||||
*
|
|
||||||
* Supplies Qt model abstractions for presenting card data in views,
|
|
||||||
* supporting filtering, sorting, and data binding to widgets.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup CardDatabaseModelFilters Filters
|
|
||||||
* @ingroup CardDatabaseModels
|
|
||||||
* @brief Filters for card database models.
|
|
||||||
*
|
|
||||||
* Provides reusable filtering components for Qt models, enabling
|
|
||||||
* refined queries and customized card data views.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup CardDatabaseParsers Parsers
|
|
||||||
* @ingroup CardDatabase
|
|
||||||
* @brief Parsers for card data.
|
|
||||||
*
|
|
||||||
* Implements parsers for card database structures, handling the
|
|
||||||
* transformation of raw data into structured objects and models.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup CardDatabaseWidgets Card Database Widgets
|
|
||||||
* @ingroup Widgets
|
* @ingroup Widgets
|
||||||
* @ingroup CardDatabase
|
* @ingroup Client
|
||||||
* @brief Widgets for browsing and selecting cards.
|
* @brief Server room management.
|
||||||
*
|
*
|
||||||
* Provides UI components for interacting with the card database,
|
* Manages creation and interaction of Game lobbies and room state synchronization with the server.
|
||||||
* including search, filtering, and browsing in tabular or list views.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup VisualCardDatabaseWidgets Visual Card Database Widgets
|
|
||||||
* @ingroup CardDatabaseWidgets
|
|
||||||
* @brief VisualDatabaseDisplayWidget and related helper classes.
|
|
||||||
*
|
|
||||||
* Enhances card browsing with graphical interfaces, offering
|
|
||||||
* image-based and grid-based views for selecting cards.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/* ------------------------------------------------------------------ */
|
|
||||||
/* UI */
|
|
||||||
/* ------------------------------------------------------------------ */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup UI User Interface
|
|
||||||
* @brief Graphical interface components built with Qt.
|
|
||||||
*
|
|
||||||
* Includes high-level widgets, dialogs, models, and editors that form
|
|
||||||
* the interactive frontend of Cockatrice.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup Widgets Widgets
|
|
||||||
* @ingroup UI
|
|
||||||
* @brief General-purpose Qt widgets.
|
|
||||||
*
|
|
||||||
* A collection of reusable widgets used throughout the application,
|
|
||||||
* such as CardInfoPictureFoilWidget, DeckAnalyticsWidget, and others.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup Tabs Tabs
|
|
||||||
* @ingroup Widgets
|
|
||||||
* @brief Tabbed UI components.
|
|
||||||
*
|
|
||||||
* Provides tab-based interfaces for organizing and navigating
|
|
||||||
* between multiple views in the application.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup DeckEditorTabs Deck Editor Tabs
|
|
||||||
* @ingroup Tabs
|
|
||||||
* @ingroup DeckEditors
|
|
||||||
* @brief Tabs for the Deck Editors
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup NetworkingTabs Networking Tabs
|
|
||||||
* @ingroup Tabs
|
|
||||||
* @ingroup NetworkingWidgets
|
|
||||||
* @brief Tabs related to a RemoteClient interacting with a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup ServerTabs Server Tabs
|
|
||||||
* @ingroup NetworkingTabs
|
|
||||||
* @brief Tabs related to a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup AccountTabs Account Tabs
|
|
||||||
* @ingroup NetworkingTabs
|
|
||||||
* @brief Tabs related to user account information.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup RoomTabs Room Tabs
|
|
||||||
* @ingroup RoomWidgets
|
|
||||||
* @brief Tabs related to a Room on a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup MessagingTabs Message Tabs
|
|
||||||
* @ingroup NetworkingTabs
|
|
||||||
* @brief Tabs related to users sending messages to each other.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup Dialogs Dialogs
|
|
||||||
* @ingroup UI
|
|
||||||
* @brief Application dialogs.
|
|
||||||
*
|
|
||||||
* Includes dialogs for card prices, deck import/export,
|
|
||||||
* settings, and other modal user interactions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup NetworkDialogs Networking Dialogs
|
|
||||||
* @ingroup Dialogs
|
|
||||||
* @ingroup NetworkingWidgets
|
|
||||||
* @brief Dialogs related to a RemoteClient interacting with a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup ClientUpdateDialogs Client Update Dialogs
|
|
||||||
* @ingroup NetworkDialogs
|
|
||||||
* @brief Dialogs relating to the client updating.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup CardDatabaseUpdateDialogs Card Database Update Dialogs
|
|
||||||
* @ingroup NetworkDialogs
|
|
||||||
* @ingroup CardDatabaseWidgets
|
|
||||||
* @brief Dialogs relating to the CardDatabase updating.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup ConnectionDialogs Connection Dialogs
|
|
||||||
* @ingroup NetworkDialogs
|
|
||||||
* @brief Dialogs relating to the RemoteClient%s connection to a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup AccountDialogs Account Dialogs
|
|
||||||
* @ingroup NetworkDialogs
|
|
||||||
* @brief Dialogs relating to account information on a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup RoomDialogs
|
|
||||||
* @ingroup NetworkDialogs
|
|
||||||
* @brief Dialogs relating to a RemoteClient interacting with a Room on a RemoteServer.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup ServerLogDialogs Server Log Dialogs
|
|
||||||
* @ingroup NetworkDialogs
|
|
||||||
* @brief Dialogs relating to a RemoteClient interacting a RemoteServer%'s logs.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup PictureLoader Card Picture Loader
|
|
||||||
* @ingroup UI
|
|
||||||
* @ingroup Cards
|
|
||||||
* @brief The PictureLoader for CardInfoPictureWidget%s and CardItem%s
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* ------------------------------------------------------------------ */
|
/* ------------------------------------------------------------------ */
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue