Class: Gnm::SheetObject

Inherits:

Object

• Object
• Gnm::SheetObject

Defined in:

(unknown)

Direct Known Subclasses

CellCombo, Comment, FilterCombo, SOFilled, SOLine, SOPath, SOPolygon, SheetObjectComponent, SheetObjectGraph, SheetObjectImage, SheetObjectWidget

Class Method Summary

• .build_menu(view, actions, i) ⇒ Gtk::Widget

  Builds the contextual menu for view.

• .move_do(objects, anchors, objects_created) ⇒ GOffice::Undo

  The newly allocated #GOUndo.

• .move_undo(objects, objects_created) ⇒ GOffice::Undo

  The newly allocated #GOUndo.

• .pts_to_anchor(anchor, sheet, res_pts) ⇒ nil

Instance Method Summary

• #adjust_stacking(positions) ⇒ Integer
• #anchor ⇒ Gnm::SheetObjectAnchor

  The Sheet::ObjectAnchor for so.

• #anchor=(anchor) ⇒ nil
• #anchor_mode=(mode) ⇒ nil
• #can_edit ⇒ Boolean
• #can_print ⇒ Boolean
• #can_resize ⇒ Boolean
• #clear_sheet ⇒ nil

  Removes so from its container, unrealizes all views, disconnects the associated data and unrefs the object.

• #component_get_component ⇒ GOffice::Component

  The embedded #GOComponent or nil on error.

• #component_set_component(component) ⇒ nil
• #default_size(w, h) ⇒ nil

  Measurements are in pts.

• #direction_set(coords) ⇒ nil

  Sets the object direction from the given the new coordinates The original coordinates are assumed to be normalized (so that top is above bottom and right is at the right of left).

• #draw_cairo(cr, rtl) ⇒ nil

  Draw a sheet object using cairo.

• #draw_cairo_sized(cr, width, height) ⇒ nil
• #dup ⇒ Gnm::SheetObject

  to a sheet.

• #exportable_get_target_list ⇒ Gtk::TargetList
• #foreach_dep(func, user) ⇒ nil

  Loops over each dependent contained in a sheet object and call the handler.

• #get_editor(sc) ⇒ nil
• #get_view(container) ⇒ Gnm::SheetObjectView

  The found Sheet::ObjectView or nil.

• #graph_ensure_size ⇒ nil

  Updates the size of the graph item in the canvas for graph sheets objects.

• #graph_get_gog ⇒ GOffice::GraphGraph

  The embedded Gog::Graph or nil on error.

• #graph_set_gog(graph) ⇒ nil

  If graph is non-nil add a reference to it, otherwise create a new graph.

• #invalidate_sheet(sheet) ⇒ nil
• #name ⇒ String

  Name.

• #name=(name) ⇒ String
• #new_view(container) ⇒ Gnm::SheetObjectView

  Asks so to create a view for container.

• #populate_menu(actions) ⇒ nil

  Get a list of the actions that can be performed on so.

• #position_pts_get(coords) ⇒ nil

  Calculate the position of the object so in pts from the logical position in the object.

• #print_flag ⇒ Boolean
• #print_flag=(print) ⇒ nil
• #range ⇒ Gnm::Range

  The Gnm::Range used for so.

• #rubber_band_directly ⇒ Boolean

  an sheet.

• #save_as_image(format, resolution, url) ⇒ nil

  Saves a sheet object as an image to url.

• #sheet ⇒ Gnm::Sheet

  A small utility to help keep the implementation of SheetObjects modular.

• #sheet=(sheet) ⇒ nil

  Adds a reference to the object.

• #stacking ⇒ Integer

  so's position in the stack of sheet objects.

• #target_list ⇒ Gtk::TargetList
• #update_bounds(p) ⇒ nil

  update the bounds of an object that intersects the region whose top left is p.

• #write_image(format, resolution, output) ⇒ nil

  Saves a sheet object as an image to output.

• #write_object(format, output, err, convs) ⇒ nil

Class Method Details

.build_menu(view, actions, i) ⇒ Gtk::Widget

Builds the contextual menu for view.

Parameters:

• view (Gnm::SheetObjectView) —

  Sheet::ObjectView

• actions (Array<Gnm::SheetObjectAction>) —

  array of actions.

• i (Integer) —

  index of first action to add in the array.

Returns:

• (Gtk::Widget) —

  the newly constructed Gtk::Menu.

.move_do(objects, anchors, objects_created) ⇒ GOffice::Undo

Returns the newly allocated #GOUndo.

Parameters:

• objects (GLib::SList<Gnm::SheetObject>)
• anchors (GLib::SList<Gnm::SheetObjectAnchor>)
• objects_created (Boolean)

Returns:

• (GOffice::Undo) —

  the newly allocated #GOUndo.

.move_undo(objects, objects_created) ⇒ GOffice::Undo

Returns the newly allocated #GOUndo.

Parameters:

• objects (GLib::SList<Gnm::SheetObject>)
• objects_created (Boolean)

Returns:

• (GOffice::Undo) —

  the newly allocated #GOUndo.

.pts_to_anchor(anchor, sheet, res_pts) ⇒ nil

Parameters:

• anchor (Gnm::SheetObjectAnchor)
• sheet (Gnm::Sheet)
• res_pts (Float)

Returns:

• (nil)

Instance Method Details

#adjust_stacking(positions) ⇒ Integer

Parameters:

• positions (Integer)

Returns:

• (Integer)

#anchor ⇒ Gnm::SheetObjectAnchor

Returns the Sheet::ObjectAnchor for so.

Returns:

• (Gnm::SheetObjectAnchor) —

  the Sheet::ObjectAnchor for so.

#anchor=(anchor) ⇒ nil

Parameters:

• anchor (Gnm::SheetObjectAnchor)

Returns:

• (nil)

#anchor_mode=(mode) ⇒ nil

Parameters:

• mode (Gnm::SOAnchorMode)

Returns:

• (nil)

#can_edit ⇒ Boolean

Returns:

• (Boolean)

#can_print ⇒ Boolean

Returns:

• (Boolean)

#can_resize ⇒ Boolean

Returns:

• (Boolean)

#clear_sheet ⇒ nil

Removes so from its container, unrealizes all views, disconnects the associated data and unrefs the object

Returns:

• (nil)

#component_get_component ⇒ GOffice::Component

Returns the embedded #GOComponent or nil on error.

Returns:

• (GOffice::Component) —

  the embedded #GOComponent or nil on error.

#component_set_component(component) ⇒ nil

Parameters:

• component (GOffice::Component)

Returns:

• (nil)

#default_size(w, h) ⇒ nil

Measurements are in pts.

Parameters:

• w (Float) —

  a ptr into which to store the default_width.

• h (Float) —

  a ptr into which to store the default_height.

Returns:

• (nil)

#direction_set(coords) ⇒ nil

Sets the object direction from the given the new coordinates The original coordinates are assumed to be normalized (so that top is above bottom and right is at the right of left)

Parameters:

• coords (Array<Float>) —

  array of coordinates in L,T,R,B order

Returns:

• (nil)

#draw_cairo(cr, rtl) ⇒ nil

Draw a sheet object using cairo.

We are assuming that the cairo context is set up so that the top left of the bounds is (0,0). Note that this is the real top left cell, not necessarily the cell with to which we are anchored.

Parameters:

• cr (cairo::Context)
• rtl (Boolean)

Returns:

• (nil)

#draw_cairo_sized(cr, width, height) ⇒ nil

Parameters:

• cr (cairo::Context)
• width (Float)
• height (Float)

Returns:

• (nil)

#dup ⇒ Gnm::SheetObject

to a sheet.

Returns:

• (Gnm::SheetObject) —

  A copy of so that is not attached

#exportable_get_target_list ⇒ Gtk::TargetList

Returns:

• (Gtk::TargetList)

#foreach_dep(func, user) ⇒ nil

Loops over each dependent contained in a sheet object and call the handler.

Parameters:

• func (Gnm::SheetObjectForeachDepFunc) —

  Sheet::ObjectForeachDepFunc

• user (GObject) —

  user data

Returns:

• (nil)

#get_editor(sc) ⇒ nil

Parameters:

• sc (Gnm::SheetControl)

Returns:

• (nil)

#get_view(container) ⇒ Gnm::SheetObjectView

Returns the found Sheet::ObjectView or nil.

Parameters:

• container (Gnm::SheetObjectViewContainer) —

  Sheet::ObjectViewContainer

Returns:

• (Gnm::SheetObjectView) —

  the found Sheet::ObjectView or nil.

#graph_ensure_size ⇒ nil

Updates the size of the graph item in the canvas for graph sheets objects.

Returns:

• (nil)

#graph_get_gog ⇒ GOffice::GraphGraph

Returns the embedded Gog::Graph or nil on error.

Returns:

• (GOffice::GraphGraph) —

  the embedded Gog::Graph or nil on error.

#graph_set_gog(graph) ⇒ nil

If graph is non-nil add a reference to it, otherwise create a new graph. Assign the graph to its SheetObjectGraph wrapper and initialize the handlers, disconnecting any existing connection for the preceding graph.

Parameters:

• graph (GOffice::GraphGraph) —

  Gog::Graph

Returns:

• (nil)

#invalidate_sheet(sheet) ⇒ nil

Parameters:

• sheet (Gnm::Sheet)

Returns:

• (nil)

#name ⇒ String

Returns name.

Returns:

• (String) —

  name

#name=(name) ⇒ String

Parameters:

• name (String)

Returns:

• (String) —

  name

• (String) —

  name

#new_view(container) ⇒ Gnm::SheetObjectView

Asks so to create a view for container.

Parameters:

• container (Gnm::SheetObjectViewContainer)

Returns:

• (Gnm::SheetObjectView) —

  the new Sheet::ObjectView.

#populate_menu(actions) ⇒ nil

Get a list of the actions that can be performed on so

Parameters:

• actions (Array<Gnm::SheetObjectAction>) —

  GPtr::Array

Returns:

• (nil)

#position_pts_get(coords) ⇒ nil

Calculate the position of the object so in pts from the logical position in the object.

Parameters:

• coords (Array<Float>) —

  coordinates

Returns:

• (nil)

#print_flag ⇒ Boolean

Returns:

• (Boolean)

#print_flag=(print) ⇒ nil

Parameters:

• print (Boolean)

Returns:

• (nil)

#range ⇒ Gnm::Range

Returns the Gnm::Range used for so.

Returns:

• (Gnm::Range) —

  the Gnm::Range used for so.

#rubber_band_directly ⇒ Boolean

an sheet. If false we draw a rectangle where the object is going to go

Returns:

• (Boolean) —

  true if we should draw the object as we are laying it out on

#save_as_image(format, resolution, url) ⇒ nil

Saves a sheet object as an image to url. If an error occurs, err will be set.

Parameters:

• format (String) —

  image format to use

• resolution (Float) —

  export resolution

• url (String) —

  destination url

Returns:

• (nil)

#sheet ⇒ Gnm::Sheet

A small utility to help keep the implementation of SheetObjects modular.

Returns:

• (Gnm::Sheet) —

  the #Sheet owning the object.

#sheet=(sheet) ⇒ nil

Adds a reference to the object.

Parameters:

• sheet (Gnm::Sheet)

Returns:

• (nil)

#stacking ⇒ Integer

Returns so's position in the stack of sheet objects.

Returns:

• (Integer) —

  so's position in the stack of sheet objects.

#target_list ⇒ Gtk::TargetList

Returns:

• (Gtk::TargetList)

#update_bounds(p) ⇒ nil

update the bounds of an object that intersects the region whose top left is p. This is used when an objects position is anchored to cols/rows and they change position.

Parameters:

• p (Gnm::CellPos) —

  A position marking the top left of the region needing relocation (default == A1)

Returns:

• (nil)

#write_image(format, resolution, output) ⇒ nil

Saves a sheet object as an image to output. If an error occurs, err will be set.

Parameters:

• format (String) —

  image format to use

• resolution (Float) —

  export resolution

• output (Gsf::Output) —

  destination

Returns:

• (nil)

#write_object(format, output, err, convs) ⇒ nil

Parameters:

• format (String)
• output (Gsf::Output)
• err (GLib::Error)
• convs (Gnm::Conventions)

Returns:

• (nil)