Gschem3

---

Description:

Content:

Namespaces:

• Geda3

Interfaces:

• AdjustableRadius - An interface for schematic items with an adjustable radius
• AdjustableSweep - An interface for schematic items with an adjustable sweep
• AttributeChild
• AttributeParent - An interface for schematic items capable of having attributes
• Colorable - An interface for schematic items that can change color
• Fillable
• GripAssistant - Provides a mechanism for grips to use functionality in the GUI (dependency inversion).
• Grippable - An interface for schematic items that provide grips
• GrippablePoints
• PathCommandConverter - Conversion strategy for path commands
• PathCommandReceiver
• StylableLine
• Invalidatable
• RemovableItem - A base class for items in the project tree
• RenamableItem - A base class for items in the project tree

Classes:

• LibraryFile - Represents a symbol file in the symbol library tree
• LibraryFolder - Represents a folder in the symbol library tree
• LibraryItem - A base class for items in the symbol library
• Project - A base class for projects
• ProjectFile - Represents a file in the project tree
• ProjectFolder - A folder in the project tree
• ProjectItem - A base class for items in the project tree
• ProjectItemAdapter - Adapts the project as an item in the project tree
• ProjectStorage - Provides a persistence layer for storing projects
• KeyFileProjectStorage - Provides a persistence layer for storing projects in key files
• KeyFileSymbolFolder - A symbol folder inside a symbol library
• KeyFileSymbolLibrary - A schematic symbol libraries based off of a key file
• KeyProjectFileMapper
• AngleGrip - An abstract Grip subclass for manipulating arc angles
• ArcItem - A schematic arc item
• BoxCornerGrip - A Grip subclass for manipulating box schematic items
• BoxCornerGripCommon
• BoxItem - Represents a graphical box on a schematic
• BusItem - Represents a bus on a schematic
• CircleItem - Schematic circle
• ComplexItem - Represents a component on a schematic
• ComplexLibrary
• ComplexSymbol
• FillStyle - The fill style for graphic items
• Grip - Abstract base class for manipulating items using grips
• LineItem - Represents a graphical line in a schematic or symbol file
• LineStyle - The line style for graphic items
• NetItem - Represents a net on a schematic
• PathCommand - An abstract base class for PathItem commands
• PathItem - Represents a graphical path on a schematic or symbol
• PinItem - Represents a pin on a schematic
• PointGrip - A Grip subclass for manipulating an item with GrippablePoints
• RadiusGrip - A Grip subclass for manipulating a radius
• Schematic
• SchematicItem - Base class for items found in schematics or symbols
• SchematicPainter
• SchematicReader
• StartAngleGrip - A Grip subclass for manipulating the starting angle of an arc
• SweepAngleGrip - A Grip subclass for manipulating the sweep angle of an arc
• TextItem - Schematic text
• AbsoluteMoveToCommand - Represents a move to path command with absolute coordinates
• AbsoluteLineToCommand - Represents a line to path command with absolute coordinates
• ClosePathCommand
• PathCommandConverter1 - Convert path commands found in the current file format
• RelativeMoveToCommand - Represents a move to path command with relative coordinates
• RelativeLineToCommand - Represents a line to path command with relative coordinates
• AttributePromoter - Provides an abstract base class for promoting attributes
• ColorScheme - Stores colors for drawing schematics
• Mapper - Maps a domain object to a database
• NullMapper - Provides a mapper that performs no operations
• PrintFormat - Stores the page format for printing
• SchematicFile
• SchematicList
• SchematicPainterCairo
• StandardPromoter
• Symbol
• SymbolLibrary - Schematic symbol libraries

Structs:

• Bounds - Stores a rectangular region
• FileVersion - Functions for operating on coordinates
• PathContext
• PrintDimension - A dimension for printing measurments

Enums:

• ProjectIcon - An enum identifying icons to use in the poject tree
• CapType - Represents the type of cap for lines
• DashType - Represents the dash type for lines
• FillType - The fill type for closed shapes
• PinType - Represents the type of pin
• TextAlignment - The alignment of text relative to the insertion point
• TextPresentation - Selects the presentation of text attributes
• Visibility - Visibility options for schematic items
• PrintOrientation - Paper orientations supported by the lepton-cli utility
• PrintUnits - Units of length used for printing

Error domains:

• MapError - Errors originating in mapping
• ParseError
• Angle - Functions for operating on angles

Methods:

• public int calc_sweep (int a0, int a1)
  Calculate the sweep between two angles
• public int from_radians (double radians)
  Convert radians to degrees
• public bool is_normal (int angle)
  Checks if an angle is [0,360)
• public bool is_ortho (int angle)
  Checks if an angle is orthographic
• public int make_ortho (int angle)
  Make an angle orthographic
• public int normalize (int angle)
  Normalize an angle to [0,360)
• public int parse (string input) throws ParseError
  Parse the string representation of an angle
• public double to_radians (int angle)
  Convert degrees to radians
• BusDirection - Functions for working with bus rippers

Constants:

• public const int MAX
  The maximum value, inclusive
• public const int MIN
  The minimum value, inclusive

Methods:

• public int parse (string input) throws ParseError
  Parse the input file representation of a bus direction
• Color - Functions for operating on color indexes

Constants:

• public const int ATTRIBUTE
  The default color index for attributes
• public const int BACKGROUND
  The color index of the background color
• public const int BOUNDING_BOX
  The default color index to use for a selection box
• public const int BUS
  The default color index for schematic busses
• public const int DETACHED_ATTRIBUTE
  The default color index for detached attributes
• public const int GRAPHIC
  The default color index for graphic objects
• public const int JUNCTION
  The default color index for junctions
• public const int LOGIC_BUBBLE
  The default color index for logic bubbles
• public const int MAJOR_GRID
  The default color index for major grid lines
• public const int MAX
  The maximum color index, inclusive
• public const int MIN
  The minimum color index, inclusive
• public const int MINOR_GRID
  The default color index minor grid lines
• public const int NET
  The default color index for schematic nets
• public const int PIN
  The default color index for schematic pins
• public const int SELECT
  The color index for selected objects
• public const int TEXT
  The default color index for text objects
• public const int ZOOM_BOX
  The color index for selecting an area to zoom

Methods:

• public int parse (string input) throws ParseError
  Parse the string representation of a color
• Coord - Functions for operating on coordinates

Methods:

• public double distance (int x0, int y0, int x1, int y1)
  Calculate the distance between two points
• public int parse (string input) throws ParseError
  Parse the string representation of a coordinate
• public void rotate (int cx, int cy, int angle, ref int x, ref int y)
  Rotate a point
• public int snap (int coord, int grid)
  Snap a coordinate to the nearest grid
• public void snap_ortho (int x0, int y0, ref int x1, ref int y1)
  Snap a line to an orthographic angle
• GeeEx - Extensions for libgee

Methods:

• public bool any_match<G> (Traversable<G> trav, Predicate<G> pred)
  Checks if any item in traversible matches the predicate
• public bool one_match<G> (Traversable<G> trav, Predicate<G> pred)
  Checks if only one item in traversible matches the predicate
• ParseUtility - Functions for parsing path strings

Methods:

• public bool parse_command (string path, ref int index, out unichar command) throws ParseError
  Parse the next command from a path string
• public int parse_param (string path, ref int index) throws ParseError
  Parse the next parameter from a path string
• Sweep - Functions for operating on angles

Methods:

• public int from_angles (int a0, int a1)
  Calculate the sweep between two angles
• public bool is_clockwise (int sweep)
  Checks if the given sweep is clockwise
• public bool is_counterclockwise (int sweep)
  Checks if the given sweep is counterclockwise
• public bool is_normal (int sweep)
  Checks if the given sweep is normal
• public int normalize (int sweep)
  Normalize a sweep angle
• public int reverse (int sweep)
  Reverse the direction of a sweep
• TextSize - Functions for working with text size

Constants:

• public const int MAX
  The maximum text size, inclusive
• public const int MIN
  The minimum text size, inclusive

Methods:

• public int parse (string input) throws ParseError
  Parse the input file representation of text size
• Gschem3

Interfaces:

• Fileable - An interface for document windows that can contain an underlying file
• ItemEditor
• Reloadable
• Savable - An interface for document windows that can save contents to a file
• Zoomable - An interface for document windows that can zoom

Classes:

• CustomAction
• AttributeEditor
• ColumnHelper - Abstrat base class for tree views that edit attributes
• PinEditorDialog - A dialog for editing pin attributes
• PinTypeColumnHelper
• TextColumnHelper
• ColorEditor - Allows editing of object properties
• ColorSwatchRenderer
• FillStyleEditor
• LineStyleEditor
• PinPropertyEditor - Allows editing of pin item properties
• PropertyComboBox
• TextPropertyEditor
• DocumentTab - Provides a widget to act as a notebook tab for a document window
• DocumentWindow - The application window for the schematic editor
• DrawingTool - An abstract base class for manipulating schematics
• DrawingToolSet
• ExportBillOfMaterial - An operation to export a bill of material from the project
• ExportBillOfMaterialDialog - A dialog box allowing the user to export a bill of material.
• ExportNetlist - An operation to export schematics from the project
• ExportNetlistDialog - A dialog box for exporting a netlist
• ExportSchematics - An operation to export schematics from the project
• FillSwatchRenderer
• Grid
• LibraryAdapter - Adapts a symbol library to a tree model
• LibraryWidget - Provides a user interface for the symbol library
• MainComplexFactory - Creates complex items for the complex drawing tool
• MainWindow
• NewProjectDialog - A dialog box to create a new project.
• PreviewWidget - Provides a preview for a schematic or symbol
• ProjectAdapter - Adapts a project to a tree model
• ProjectWidget
• SchematicWindow - A document window for editing a gschem schematic
• SchematicWindowSettings - Settings shared by all schematic windows
• MeshGrid
• NoGrid
• ArcTool
• BoxTool
• BusTool
• CircleTool
• ComplexFactory - Creates complex items for the complex drawing tool
• ComplexTool - Places complex items onto a schematic
• LineTool - A tool for drawing graphic lines on the schematic
• NetTool
• PathTool
• PinAttributeUpdater
• PinItemGroup
• PinSettings - Settings for the pin tool
• PinTool
• PinUpdater
• SelectTool
• ZoomTool - A tool for zooming in on a specific area

Enums:

• ValueState
• ErrorDialog

Methods:

• public void show_with_file (Window? parent, Error error, File? file)
  Show an error dialog for a file operation