MainWindow/documentation.h

   1 /**
   2   \namespace MainWindow
   3   \brief The main window plus a number of dialogs.
   4
   5   <h2>The Main %Window</h2>
   6   The class \ref Window is the central collection point for most of the
   7   application. It is responsible for setting up the main window, and
   8   connecting all its sub components.
   9
  10   This is also the place where you will find the code setting up the menu
  11   bars and tool bars, and connecting their signals to slots
  12
  13   <h2>Main %Window Components</h2>
  14   This namespace also contains a few classes that you will find in the main
  15   %window itself. These are:
  16
  17   \li SearchBar - This is the search bar located in the toolbar.
  18   \li DirtyIndicator - this is the small image in the toolbar that indicate
  19   whether there are unsaved data. At the same time it is also the authority
  20   regarding whether there are saved data (so this is the place where there
  21   is a boolean the rest of the application will set when there are unsaved changes).
  22   \li ImageCounter  - this is the label in the status bar showing amount of
  23   matched and total images.
  24   \li BreadcrumbViewer - this is the widget containing the breadcrumbs
  25   located in the status bar.
  26
  27
  28   <h2>Dialogs</h2>
  29
  30   In addition to the main %window and its component, this namespace also
  31   contains a number of dialogs, that are accessed from the menu bar.
  32
  33   \li DeleteDialog - the Delete Images/Videos dialog.
  34   \li FeatureDialog - The Feature Status dialog.
  35   \li StatisticsDialog - The statistics dialog.
  36   \li TokenEditor - The dialog used for deleting tokens.
  37   \li WelcomeDialog - The dialog shown the first time a user starts KPhotoAlbum.
  38   \li InvalidDateFinder - The dialog used to find images with invalid or
  39   incomplete dates.
  40
  41   <h2>Other Classes</h2>
  42   \li ExternalPopup - this is the sub menu of the context menu, showing the
  43   external application that the given image can be handed to.
  44   \li SplashScreen - the splash screen shown at start up
  45
  46
  47 **/