• Packages

---

• Gschem3

---

• Gschem3

---

• SchematicWindow

---

• SCHEMATIC_EXTENSION
• SYMBOL_EXTENSION
• can_reload
• changed
• file
• file_id
• modified
• selection
• settings
• create
• SchematicWindow
• add_item
• clear_selection
• closest_item
• device_to_user
• device_to_user_distance
• invalidate_bounds
• invalidate_device
• invalidate_item
• invalidate_user
• on_color_scheme_changed
• on_invalidate_item
• pan_delta
• pan_point
• reload
• save
• save_as
• scale_grid_down
• scale_grid_up
• select_all
• select_box
• select_grid
• select_item
• snap_angle
• snap_point
• user_to_device
• zoom_box
• zoom_extents
• zoom_in_center
• zoom_in_point
• zoom_out_center
• zoom_out_point
• attribute_changed
• color_scheme_changed
• draw_tool
• selection_changed
• tool_button_press_event
• tool_button_release_event
• tool_key_press_event
• tool_key_release_event
• tool_motion_notify_event
• schematic

SchematicWindow

---

Object Hierarchy:

Description:

public class SchematicWindow : DocumentWindow, Fileable, Invalidatable, Reloadable, Savable, Zoomable

A document window for editing a gschem schematic

Namespace: Gschem3

Package: Gschem3

Content:

Constants:

• public const unowned string SCHEMATIC_EXTENSION
  The filename extension for schematic files
• public const unowned string SYMBOL_EXTENSION
  The filename extension for symbol files

Properties:

• public bool can_reload { protected set; get; }
  Indicates the document can be reloaded
• public bool changed { protected set; get; }
  Indicates the document has changed since last saved
• public File? file { protected set; get; }
  The underlying file for the schematic
• public string? file_id { protected set; get; }
• A unique string identifing the file

public bool modified { protected set; get; }

Indicates the file has been modified

Static methods:

• public static SchematicWindow create (File file, ComplexFactory factory) throws Error
  Create a schematic window and load the given schematic file

Creation methods:

• public SchematicWindow (ComplexFactory factory)
  Create a schematic window with an untitled schematic

Methods:

• public void clear_selection ()
  Unselect all items
• public SchematicItem? closest_item (int x, int y, double distance)
  Find the closest item the the given coordinates
• public void add_item (SchematicItem item)
  Add an item to the schematic
• public void device_to_user (ref double x, ref double y)
  Convert device coordinates to user coordinates
• public void device_to_user_distance (ref double dx, ref double dy)
  Convert device displacement to user displacement
• public void invalidate_bounds (Bounds bounds)
  Invalidate an area of the window in user coordinates
• public void invalidate_device (double x0, double y0, double x1, double y1)
• public void invalidate_item (SchematicItem item, bool reveal)
  Invalidate an item in the window
• public void on_invalidate_item (SchematicItem item)
• public void invalidate_user (Bounds bounds)
  Invalidate an area of the window in user coordinates
• public void reload (Window? parent) throws Error
  Reloads the document from the file
• public void pan_delta (int dx, int dy)
  Pan a point to the center of the window
• public void pan_point (int x, int y)
  Pan a point to the center of the window
• public void save (Window? parent) throws Error
  Save the document in the window
• public void save_as (Window? parent) throws Error
  Save the document in the window with another filename
• public void scale_grid_down ()
• public void scale_grid_up ()
• public void select_all ()
  Select all items in the schematic
• public void select_box (Bounds box)
  Select items using a box
• public void select_grid (string name)
  Select a drawing grid for this window
• public void select_item (SchematicItem? item, bool toggle)
  Places a single item in the selection
• public int snap_angle (int angle)
  Snap an angle using the current snap mode
• public void snap_point (ref int x, ref int y)
  Snap a point to the grid of this window
• public void user_to_device (double ux, double uy, out double dx, out double dy)
  Convert user coordinates to device coordinates
• public void zoom_box (double x0, double y0, double x1, double y1)
  Zoom to a box
• public void zoom_extents ()
  Zoom the schematic to fit the view
• public void zoom_in_center ()
  Zoom in on the center of the window
• public void zoom_in_point (int x, int y)
  Zoom in and center point in window
• public void zoom_out_center ()
  Zoom out on the center of the window
• public void zoom_out_point (int x, int y)
  Zoom out and center point in window
• public void on_color_scheme_changed (ColorScheme scheme)
  Event handler for when the color scheme changes

Signals:

• public signal void attribute_changed (AttributeChild child, AttributeParent parent)
  A signal inicating an attriubte has changed
• public signal void color_scheme_changed (ColorScheme scheme)
  A signal indicating the color scheme has changed
• public signal void draw_tool (SchematicPainter painter)
  A signal indicating items in the selection have changed
• public signal void selection_changed ()
  A signal indicating items in the selection have changed
• public signal bool tool_button_press_event (EventButton event)
• public signal bool tool_button_release_event (EventButton event)
• public signal bool tool_key_press_event (EventKey event)
• public signal bool tool_key_release_event (EventKey event)
• public signal bool tool_motion_notify_event (EventMotion event)

Fields:

• public Schematic schematic
  The schematic this window is editing

Inherited Members: