Package grc.Constants


Variables

string VERSION = 'reloaded (trunk)'
 The current version of this code.
string NEW_FLOGRAPH_TITLE = 'untitled'
 The name to appear in the main window for a flow graph that has not been saved to file.
string MAIN_WINDOW_PREFIX = "GRC"
 The prefix title on the main window.
int CONNECTOR_EXTENSION_INITIAL_LENGTH = 11
 The length that a connection must extend from the port until the length depends on the index of the port.
int CONNECTOR_EXTENSION_LENGTH = 11
 The length that a connection must extend from the initial length times the index of the port, after this length, the connection may have a bend.
int CONNECTOR_ARROW_BASE = 13
 The length of the connector arrow base in pixels.
int CONNECTOR_ARROW_HEIGHT = 17
 The length of the connector arrow height in pixels.
tuple POSSIBLE_ROTATIONS = (0, 90, 180, 270)
 List of possible angles (in degrees) that a block can be rotated to.
string DIR_LEFT = 'left'
 direction of rotation left.
string DIR_RIGHT = 'right'
 direction of rotation right.
int MIN_WINDOW_WIDTH = 600
 main window constraints
int MIN_WINDOW_HEIGHT = 400
int MIN_DIALOG_WIDTH = 500
 dialog constraints
int MIN_DIALOG_HEIGHT = 500
int REPORTS_WINDOW_HEIGHT = 100
 static height of reports window
int BLOCK_SELECTION_WINDOW_WIDTH = 200
 static width of block selection window
int LABEL_SEPARATION = 3
int LABEL_PADDING_WIDTH = 9
int LABEL_PADDING_HEIGHT = 9
int PORT_SEPARATION = 17
int PORT_HEIGHT = 15
int PORT_WIDTH = 25
int PORT_BORDER_SEPARATION = 9
int MAX_NUM_PORTS = 7
string PARAM_LABEL_FONT = 'Sans 9.5'
string PARAM_FONT = 'Sans 7.5'
string BLOCK_FONT = 'Sans 8'
string PORT_FONT = 'Sans 7.5'
int BORDER_PROXIMITY_SENSITIVITY = 50
 How close can the mouse get to the window border before mouse events are ignored.
int SCROLL_PROXIMITY_SENSITIVITY = 30
 How close the mouse can get to the edge of the visible window before scrolling is invoked.
int SCROLL_DISTANCE = 15
 When the window has to be scrolled, move it this distance in the required direction.
int MOTION_DETECT_REDRAWING_SENSITIVITY = 02
 The redrawing sensitivity, how many seconds must pass between motion events before a redraw?
int CONNECTION_SELECT_SENSITIVITY = 5
 How close the mouse click can be to a connection and register a connection select.
int STATE_CACHE_SIZE = 42
 The size of the state saving cache in the flow graph (for undo/redo functionality).
tuple SRC_DIR = os.path.abspath(os.path.dirname(__file__))
 Location of the python src directory.
tuple DATA_DIR = os.path.join(SRC_DIR, 'data')
 Location of external data files.
tuple FLOW_GRAPH_DTD = os.path.join(DATA_DIR, 'flow_graph.dtd')
 DTD validator for saved flow graphs.
string FLOW_GRAPH_FILE_EXTENSION = '.grc'
 The default file extension for flow graphs.
string IMAGE_FILE_EXTENSION = '.png'
 The default file extension for saving flow graph snap shots.
tuple DEFAULT_FILE_PATH = os.getcwd()
 The default path for the open/save dialogs.
tuple PY_GTK_ICON = os.path.join(DATA_DIR, 'grc-icon-256.png')
 The default icon for the gtk windows.
tuple HOME_DIR = os.path.expanduser('~')
 The users home directory.


Detailed Description

Global constants
Author:
Josh Blum

Variable Documentation

string grc::Constants.BLOCK_FONT = 'Sans 8' [static]

Definition at line 101 of file Constants.py.

int grc::Constants.BLOCK_SELECTION_WINDOW_WIDTH = 200 [static]

static width of block selection window

Definition at line 83 of file Constants.py.

int grc::Constants.BORDER_PROXIMITY_SENSITIVITY = 50 [static]

How close can the mouse get to the window border before mouse events are ignored.

Dragging, scrolling, and redrawing constants for the flow graph window in pixels

Definition at line 109 of file Constants.py.

int grc::Constants.CONNECTION_SELECT_SENSITIVITY = 5 [static]

How close the mouse click can be to a connection and register a connection select.

Definition at line 121 of file Constants.py.

int grc::Constants.CONNECTOR_ARROW_BASE = 13 [static]

The length of the connector arrow base in pixels.

Definition at line 49 of file Constants.py.

int grc::Constants.CONNECTOR_ARROW_HEIGHT = 17 [static]

The length of the connector arrow height in pixels.

Definition at line 52 of file Constants.py.

int grc::Constants.CONNECTOR_EXTENSION_INITIAL_LENGTH = 11 [static]

The length that a connection must extend from the port until the length depends on the index of the port.

Signal block connector lengths

Definition at line 43 of file Constants.py.

int grc::Constants.CONNECTOR_EXTENSION_LENGTH = 11 [static]

The length that a connection must extend from the initial length times the index of the port, after this length, the connection may have a bend.

Definition at line 46 of file Constants.py.

tuple grc::Constants.DATA_DIR = os.path.join(SRC_DIR, 'data') [static]

Location of external data files.

Definition at line 138 of file Constants.py.

tuple grc::Constants.DEFAULT_FILE_PATH = os.getcwd() [static]

The default path for the open/save dialogs.

Definition at line 150 of file Constants.py.

string grc::Constants.DIR_LEFT = 'left' [static]

direction of rotation left.

Definition at line 62 of file Constants.py.

string grc::Constants.DIR_RIGHT = 'right' [static]

direction of rotation right.

Definition at line 65 of file Constants.py.

tuple grc::Constants.FLOW_GRAPH_DTD = os.path.join(DATA_DIR, 'flow_graph.dtd') [static]

DTD validator for saved flow graphs.

Definition at line 141 of file Constants.py.

string grc::Constants.FLOW_GRAPH_FILE_EXTENSION = '.grc' [static]

The default file extension for flow graphs.

Definition at line 144 of file Constants.py.

tuple grc::Constants.HOME_DIR = os.path.expanduser('~') [static]

The users home directory.

Definition at line 156 of file Constants.py.

string grc::Constants.IMAGE_FILE_EXTENSION = '.png' [static]

The default file extension for saving flow graph snap shots.

Definition at line 147 of file Constants.py.

int grc::Constants.LABEL_PADDING_HEIGHT = 9 [static]

Definition at line 91 of file Constants.py.

int grc::Constants.LABEL_PADDING_WIDTH = 9 [static]

Definition at line 90 of file Constants.py.

int grc::Constants.LABEL_SEPARATION = 3 [static]

Constraints on displayable labels and ports

Definition at line 89 of file Constants.py.

string grc::Constants.MAIN_WINDOW_PREFIX = "GRC" [static]

The prefix title on the main window.

Definition at line 36 of file Constants.py.

int grc::Constants.MAX_NUM_PORTS = 7 [static]

Definition at line 97 of file Constants.py.

int grc::Constants.MIN_DIALOG_HEIGHT = 500 [static]

Definition at line 77 of file Constants.py.

int grc::Constants.MIN_DIALOG_WIDTH = 500 [static]

dialog constraints

Definition at line 76 of file Constants.py.

int grc::Constants.MIN_WINDOW_HEIGHT = 400 [static]

Definition at line 73 of file Constants.py.

int grc::Constants.MIN_WINDOW_WIDTH = 600 [static]

main window constraints

Dimension constraints for the various windows (in pixels)

Definition at line 72 of file Constants.py.

int grc::Constants.MOTION_DETECT_REDRAWING_SENSITIVITY = 02 [static]

The redrawing sensitivity, how many seconds must pass between motion events before a redraw?

Definition at line 118 of file Constants.py.

string grc::Constants.NEW_FLOGRAPH_TITLE = 'untitled' [static]

The name to appear in the main window for a flow graph that has not been saved to file.

Definition at line 33 of file Constants.py.

string grc::Constants.PARAM_FONT = 'Sans 7.5' [static]

Definition at line 100 of file Constants.py.

string grc::Constants.PARAM_LABEL_FONT = 'Sans 9.5' [static]

Definition at line 99 of file Constants.py.

int grc::Constants.PORT_BORDER_SEPARATION = 9 [static]

Definition at line 96 of file Constants.py.

string grc::Constants.PORT_FONT = 'Sans 7.5' [static]

Definition at line 102 of file Constants.py.

int grc::Constants.PORT_HEIGHT = 15 [static]

Definition at line 94 of file Constants.py.

int grc::Constants.PORT_SEPARATION = 17 [static]

Definition at line 93 of file Constants.py.

int grc::Constants.PORT_WIDTH = 25 [static]

Definition at line 95 of file Constants.py.

tuple grc::Constants.POSSIBLE_ROTATIONS = (0, 90, 180, 270) [static]

List of possible angles (in degrees) that a block can be rotated to.

Signal block rotations

Definition at line 59 of file Constants.py.

tuple grc::Constants.PY_GTK_ICON = os.path.join(DATA_DIR, 'grc-icon-256.png') [static]

The default icon for the gtk windows.

Definition at line 153 of file Constants.py.

int grc::Constants.REPORTS_WINDOW_HEIGHT = 100 [static]

static height of reports window

Definition at line 80 of file Constants.py.

int grc::Constants.SCROLL_DISTANCE = 15 [static]

When the window has to be scrolled, move it this distance in the required direction.

Definition at line 115 of file Constants.py.

int grc::Constants.SCROLL_PROXIMITY_SENSITIVITY = 30 [static]

How close the mouse can get to the edge of the visible window before scrolling is invoked.

Definition at line 112 of file Constants.py.

tuple grc::Constants.SRC_DIR = os.path.abspath(os.path.dirname(__file__)) [static]

Location of the python src directory.

Constansts dealing with File Paths

Definition at line 135 of file Constants.py.

int grc::Constants.STATE_CACHE_SIZE = 42 [static]

The size of the state saving cache in the flow graph (for undo/redo functionality).

Definition at line 128 of file Constants.py.

string grc::Constants.VERSION = 'reloaded (trunk)' [static]

The current version of this code.

Global Titles

Definition at line 30 of file Constants.py.


Generated on Sat Aug 23 02:00:11 2008 for GNU Radio Companion by  doxygen 1.5.4