Changeset 300:f101bd18f39d


Ignore:
Timestamp:
07/22/12 17:28:25 (12 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
default
Phase:
public
Message:

Added the module comments for the GUI

Location:
src/mlx/gui
Files:
14 edited

Legend:

Unmodified
Added
Removed
  • src/mlx/gui/callouts.py

    r283 r300  
    1 # Module for editing checklists
    2 
    3 #------------------------------------------------------------------------------
    41
    52from common import *
     
    118import os
    129import re
     10
     11#------------------------------------------------------------------------------
     12
     13## @package mlx.gui.callouts
     14#
     15# Editor dialog for approach callouts.
     16#
     17# The dialog consists of an aircraft type selector box at the top, and a table
     18# with two buttons below it. The table contains the callout files with the
     19# corresponding altitudes, and is sorted according to the altitude. When a new
     20# file is added, the program finds out a new altitude for it. If the file's
     21# name contains numbers that are not used as altitudes yet, the most suitable
     22# of those numbers will be used. Otherwise a 'usual' altitude is searched for,
     23# in the direction according to the sort order, and if that fails too, the
     24# altitudes are tried one-by-one. See the
     25# \ref ApproachCalloutsEditor._getNewAltitude function for more details.
    1326
    1427#------------------------------------------------------------------------------
  • src/mlx/gui/checklist.py

    r280 r300  
    1 # Module for editing checklists
    2 
    3 #------------------------------------------------------------------------------
    41
    52from common import *
     
    107
    118import os
     9
     10#------------------------------------------------------------------------------
     11
     12## @package mlx.gui.checklist
     13#
     14# The checklist editor dialog.
     15#
     16# This module implements the checklist editor dialog. A checklist is a list of
     17# sound files that are played one-by-one when requested by the user. The top
     18# part of the dialog contains an aircraft type selector. Below it, on the left
     19# there is a file selector, and the list of the files in the checklist to the
     20# right. There are some buttons in the middle to manipulate the checklist.
    1221
    1322#------------------------------------------------------------------------------
  • src/mlx/gui/common.py

    r277 r300  
    1 # Common things for the GUI
    21
    32import mlx.const as _const
     
    54
    65import os
     6
     7#-----------------------------------------------------------------------------
     8
     9## @package mlx.gui.common
     10#
     11# Common definitions and utilities for the GUI
     12#
     13# The main purpose of this module is to provide common definitions for things
     14# that are named differently in Gtk+ 2 and 3. This way the other parts of the
     15# GUI have to check the version in use very rarely. The variable \ref pygobject
     16# tells which version is being used. If it is \c True, Gtk+ 3 is used via the
     17# PyGObject interface. Otherwise Gtk+ 2 is used, which is the default on
     18# Windows or when the \c FORCE_PYGTK environment variable is set.
     19#
     20# Besides this there some common utility classes and functions.
     21
     22#-----------------------------------------------------------------------------
    723
    824appIndicator = False
  • src/mlx/gui/flight.py

    r278 r300  
    1 # The flight handling "wizard"
    21
    32from mlx.gui.common import *
     
    1514import datetime
    1615import time
     16
     17#-----------------------------------------------------------------------------
     18
     19## @package mlx.gui.flight
     20#
     21# The flight "wizard".
     22#
     23# This module implements the main tab of the application, the flight
     24# wizard. The wizard consists of \ref Page "pages", that come one after the
     25# other. As some pages might be skipped, the pages dynamically store the index
     26# of the previous page so that going back to it is simpler. The \ref
     27# Page.activate "activate" function is called before a page is first shown
     28# during a flight. This function should initialize the page's controls and fill
     29# it with initial data. When a page is left for the first time, its \ref
     30# Page.finalize "finalize" function is called. It should set those controls
     31# insensitive, that will not be available if the user comes back to this page.
     32#
     33# Each page has a title at the top displayed in inverted colors and a big
     34# font. There is a help text below it centered, that shortly describes what is
     35# expected on the page. There can be two help texts: one shown when the page is
     36# first displayed during a flight, another shown when the user goes back to the
     37# page. The main content area is below this, also centered. Finally, there are
     38# some buttons at the bottom on the right. As some buttons occur very
     39# frequently, there are functions to add them (\ref Page.addCancelFlightButton
     40# "addCancelFlightButton", \ref Page.addPreviousButton "addPreviousButton" and
     41# \ref Page.addNextButton "addNextButton".
     42#
     43# The \ref Wizard class is the main class to collect the pages. It also stores
     44# some data passed from one page to another and provides properties to access
     45# data items set via the wizard pages.
    1746
    1847#-----------------------------------------------------------------------------
  • src/mlx/gui/gates.py

    r121 r300  
    1 # Module to display the status of the planes and the gates
    2 
    3 #----------------------------------------------------------------------------
    41
    52from mlx.gui.common import *
     
    74from mlx.i18n import xstr
    85import mlx.const as const
     6
     7#-------------------------------------------------------------------------------
     8
     9## @package mlx.gui.gates
     10#
     11# The gate status display.
     12#
     13# This module contains the \ref FleetGateStatus widget, which is the tab
     14# displaying the status of the MAVA Fleet and the gates at LHBP. The left side
     15# of the widget is the table with the list of the planes and their states. The
     16# right side displays the numbers of the gates and their occupation status.
    917
    1018#-------------------------------------------------------------------------------
  • src/mlx/gui/gui.py

    r281 r300  
    1 # The main file for the GUI
    21# -*- coding: utf-8 -*-
    32
     
    3231import datetime
    3332import webbrowser
     33
     34#------------------------------------------------------------------------------
     35
     36## @package mlx.gui.gui
     37#
     38# The main GUI class.
     39#
     40# The \ref GUI class is the main class of the GUI. It is a connection listener,
     41# and aggregates all the windows, the menu, etc. It maintains the connection to
     42# the simulator as well as the flight object.
    3443
    3544#------------------------------------------------------------------------------
  • src/mlx/gui/info.py

    r128 r300  
    1 #The Flight Info tab
    21
    32from common import *
     
    54from mlx.i18n import xstr
    65import mlx.const as const
     6
     7#------------------------------------------------------------------------------
     8
     9## @package mlx.gui.info
     10#
     11# The flight info tab.
     12#
     13# This module implements to \ref FlightInfo class, which is the widget for the
     14# extra information related to the flight. It contains text areas for the
     15# comments and the flight defects at the top next to each other, and the frame
     16# for the delay codes at the bottom in the centre.
    717
    818#------------------------------------------------------------------------------
  • src/mlx/gui/monitor.py

    r274 r300  
    1 # The monitoring window
    21
    32from mlx.gui.common import *
     
    76
    87import time
     8
     9#------------------------------------------------------------------------------
     10
     11## @package mlx.gui.monitor
     12#
     13# The monitoring window
     14#
     15# The \ref MonitorWindow class is a window containing the data received from
     16# the simulator by the logger.
    917
    1018#------------------------------------------------------------------------------
  • src/mlx/gui/pirep.py

    r238 r300  
    1 # Module for the detailed PIREP viewer
    2 
    3 #------------------------------------------------------------------------------
    41
    52from common import *
     
    96
    107import time
     8
     9#------------------------------------------------------------------------------
     10
     11## @package mlx.gui.pirep
     12#
     13# The detailed PIREP viewer.
     14#
     15# The \ref PIREPViewer class is a dialog displaying all information found in a
     16# PIREP. It consists of three tabs. The Data tab displays the simple,
     17# itemizable data. The Comments & defects tab contains the flight comments and
     18# defects, while the Log tab contains the flight log collected by the
     19# \ref mlx.logger.Logger "logger".
    1120
    1221#------------------------------------------------------------------------------
  • src/mlx/gui/prefs.py

    r270 r300  
    1 # Module for the preferences dialog
    2 
    3 #------------------------------------------------------------------------------
    41
    52from common import *
     
    107
    118import urlparse
     9
     10#------------------------------------------------------------------------------
     11
     12## @package mlx.gui.prefs
     13#
     14# The preferences dialog.
     15#
     16# This module implements the preferences dialog, allowing the editing of the
     17# configuration of the program. The preferences are grouped into tabs, each
     18# containing the necessary controls to set the various options.
    1219
    1320#------------------------------------------------------------------------------
  • src/mlx/gui/statusbar.py

    r281 r300  
    1 # Implementation of the status bar.
    2 
    3 #-------------------------------------------------------------------------------
    41
    52from common import *
     
    107import math
    118import time
     9
     10#-------------------------------------------------------------------------------
     11
     12## @package mlx.gui.statusbar
     13#
     14# The status bar.
     15#
     16# This module implements the status bar seen at the lower part of the main
     17# window. It contains the icon depicting the status of the connection to the
     18# simulator, the current flight stage, rating and the simulator time.
    1219
    1320#-------------------------------------------------------------------------------
  • src/mlx/gui/statusicon.py

    r128 r300  
    1 # Implementation of the status icon
    2 
    3 #-------------------------------------------------------------------------------
    41
    52from common import *
     
    74import mlx.const as const
    85from mlx.i18n import xstr
     6
     7#-------------------------------------------------------------------------------
     8
     9## @package mlx.gui.statusicon
     10#
     11# The status icon.
     12#
     13# This module implements that status icon displayed on the Windows or the GNOME
     14# taskbar, or whatever the place for status icons is called in the used
     15# environment. It works with both the more modern appindicator interface
     16# (mainly found on Ubuntu), if that is available, or with the older status icon
     17# support in Gtk (which is used on Windows as well). In this latter case, the
     18# icon has a tooltip with the flight stage and rating information, while these
     19# data are placed into the menu in case of appindicator.
    920
    1021#-------------------------------------------------------------------------------
  • src/mlx/gui/update.py

    r124 r300  
    1 # The GUI part of the update
    2 
    3 #-------------------------------------------------------------------------------
    41
    52from mlx.gui.common import *
     
    1310import os
    1411import sys
     12
     13#-------------------------------------------------------------------------------
     14
     15## @package mlx.gui.update
     16#
     17# The GUI part of the update.
     18#
     19# This module implements the GUI portion of the \ref mlx.update
     20# "automatic update" function. The update runs in a separate thread, which puts
     21# the relevant events into the Gtk event loop.
    1522
    1623#-------------------------------------------------------------------------------
  • src/mlx/gui/weighthelp.py

    r117 r300  
    1 # The weight calculation help window
    2 
    3 #-------------------------------------------------------------------------------
    41
    52from mlx.gui.common import *
     
    74from mlx.i18n import xstr
    85from mlx.checks import PayloadChecker
     6
     7#-------------------------------------------------------------------------------
     8
     9## @package mlx.gui.weighthelp
     10#
     11# The weight calculation help tab.
     12#
     13# This module implements the tab containing the weight calculation help.
    914
    1015#-------------------------------------------------------------------------------
Note: See TracChangeset for help on using the changeset viewer.