Class: Gnm::App

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.add_extra_ui(group_name, actions, layout, domain) ⇒ Gnm::AppExtraUI

Returns the newly allocated Gnm::AppExtraUI.

Parameters:

  • group_name (String) —

    action group name.

  • actions (GLib::SList<Gnm::Action>) —

    list of actions.

  • layout (String) —

    the xml string describing the menus and toolbars.

  • domain (String) —

    localization domain.

Returns:

  • (Gnm::AppExtraUI) —

    the newly allocated Gnm::AppExtraUI.

.app ⇒ GObject::Object

Returns the Gnm::App instance.

Returns:

  • (GObject::Object) —

    the Gnm::App instance.

.clipboard_area_get ⇒ Gnm::Range

Returns the current range in the clipboard.

Returns:

  • (Gnm::Range) —

    the current range in the clipboard.

.clipboard_clear(drop_selection) ⇒ nil

Clear and free the contents of the clipboard if it is not empty.

Parameters:

  • drop_selection (Boolean)

Returns:

  • (nil)

.clipboard_contents_get ⇒ Gnm::CellRegion

Returns the current contents of the clipboard.

Returns:

  • (Gnm::CellRegion) —

    the current contents of the clipboard.

.clipboard_cut_copy(wbc, is_cut, sv, area, animate_range) ⇒ nil

When Cutting we Clear and free the contents of the clipboard and save the sheet and area to be cut. DO NOT ACTUALLY CUT! Paste will move the region if this was a cut operation.

When Copying we Clear and free the contents of the clipboard and COPY the designated region into the clipboard.

we need to pass wbc as a control rather than a simple command-context so that the control can claim the selection.

Parameters:

  • wbc (Gnm::WorkbookControl) —

    the workbook control that requested the operation.

  • is_cut (Boolean) —

    is this a cut or a copy.

  • sv (Gnm::SheetView) —

    The source sheet for the copy.

  • area (Gnm::Range) —

    A single rectangular range to be copied.

  • animate_range (Boolean) —

    Do we want to add an animated cursor around things.

Returns:

  • (nil)

.clipboard_cut_copy_obj(wbc, is_cut, sv, objects) ⇒ nil

Different than copying/cutting a region, this can actually cut an object of Sheet::Object

Parameters:

Returns:

  • (nil)

.clipboard_invalidate_sheet(sheet) ⇒ nil

Parameters:

Returns:

  • (nil)

.clipboard_is_cut ⇒ Boolean

Returns:

  • (Boolean)

.clipboard_is_empty ⇒ Boolean

Returns:

  • (Boolean)

.clipboard_sheet_get ⇒ Gnm::Sheet

Returns the current clipboard #Sheet.

Returns:

.clipboard_sheet_view_get ⇒ Gnm::SheetView

Returns the current clipboard Sheet::View.

Returns:

.clipboard_unant ⇒ nil

Returns:

  • (nil)

.create_opener_filter(openers) ⇒ GObject

Creates a Gtk::FileFilter from the list of file types supported by the openers in the list.

Parameters:

  • openers (GLib::List<GOffice::FileOpener>) —

    a list of file openers.

Returns:

  • (GObject) —

    the newly allocated Gtk::FileFilter.

.display_dpi_get(horizontal) ⇒ Float

Parameters:

  • horizontal (Boolean)

Returns:

  • (Float)

.dpi_to_pixels ⇒ Float

Returns:

  • (Float)

.flag_windows_changed_ ⇒ nil

An internal utility routine to flag a regeneration of the window lists

Returns:

  • (nil)

.foreach_extra_ui(func, data) ⇒ nil

Applies func to each Gnm::AppExtraUI.

Parameters:

  • func (GLib::Func) —

    #GFunc

  • data (GObject) —

    user data.

Returns:

  • (nil)

.history_add(filename, mimetype) ⇒ nil

Parameters:

  • filename (String)
  • mimetype (String)

Returns:

  • (nil)

.history_get_list(max_elements) ⇒ GLib::SList<String>

creating it if necessary. freed along with the strings in it.

Parameters:

  • max_elements (Integer)

Returns:

  • (GLib::SList<String>) —

    the list, which must be

.initial_open_complete ⇒ Boolean

Returns:

  • (Boolean)

.recalc ⇒ nil

Recalculate everything dirty in all workbooks that have automatic recalc turned on.

Returns:

  • (nil)

.recalc_clear_caches ⇒ nil

Returns:

  • (nil)

.recalc_finish ⇒ nil

Returns:

  • (nil)

.recalc_start ⇒ nil

Returns:

  • (nil)

.remove_extra_ui(extra_ui) ⇒ nil

Parameters:

  • extra_ui (Gnm::AppExtraUI)

Returns:

  • (nil)

.sanity_check ⇒ nil

Returns:

  • (nil)

.shutting_down ⇒ Boolean

Returns:

  • (Boolean)

.workbook_get_by_index(i) ⇒ Gnm::Workbook

Get nth workbook. Index is zero-based.

Parameters:

  • i (Integer) —

    index

Returns:

.workbook_get_by_name(name, ref_uri) ⇒ Gnm::Workbook

Returns the #Workbook or nil.

Parameters:

  • name (String) —

    the workbook name.

  • ref_uri (String)

Returns:

.workbook_list ⇒ GLib::List<Gnm::Workbook>

Returns the workbook list.

Returns:

.workbook_list_add(wb) ⇒ nil

Add wb to the application's list of workbooks.

Parameters:

Returns:

  • (nil)

.workbook_list_remove(wb) ⇒ nil

Remove wb from the application's list of workbooks.

Parameters:

Returns:

  • (nil)

Instance Method Details

#file_history_list ⇒ GObject

Returns file-history-list.

Returns:

  • (GObject) —

    file-history-list

#file_history_list=(file_history_list) ⇒ GObject

Parameters:

  • file_history_list (GObject)

Returns:

  • (GObject) —

    file-history-list

  • (GObject) —

    file-history-list

#initial_open_complete=(initial_open_complete) ⇒ Boolean

Parameters:

  • initial_open_complete (Boolean)

Returns:

  • (Boolean) —

    initial-open-complete

  • (Boolean) —

    initial-open-complete

#initial_open_complete? ⇒ Boolean

Returns initial-open-complete.

Returns:

  • (Boolean) —

    initial-open-complete

#shutting_down=(shutting_down) ⇒ Boolean

Parameters:

  • shutting_down (Boolean)

Returns:

  • (Boolean) —

    shutting-down

  • (Boolean) —

    shutting-down

#shutting_down? ⇒ Boolean

Returns shutting-down.

Returns:

  • (Boolean) —

    shutting-down