0.15.0-betaAll editor types available to the software.
A class that contains data for an editor.
File types that can be found in a grimoires project.
function used to easly fetch GFileType enum keys and values as text.
(any)
Encapsulate a generic grimoire file. Is used when getting a projects source tree.
A class that contains a hash property. It is used to store files has hashes.
instanciate a new object from another set of data to copy or deserialize another place.
(any)
get this agglomeration type translated in french.
instanciate a new object from another set of data to copy or deserialize another place.
(any)
fetch a static icon associated with a place that can be used to draw on the map's canvas.
(any)
Settings class, expose a container of sections containing settings.
creates a settings class from string, useful to serialize from json.
(any)
Retrieve a given parameter from a section.
(any)
(any)
A builder class used to easily initialize hardcoded settings.
Add a new section to the setting list.
(any)
Add a parameter if type SettingType into a given section.
build the Settings class with the provided parameters.
All different types of sheet available for the character sheet editor.
A sheet is a data field that is displayed inside the character sheet editor. A box object contain multiple sheets.
A box object used to store and display data for a character in the character sheet editor.
A sheet template is used to instantiate multiple sheets in a box. It can be used to prevent adding already existing patterns of sheets. For example, by default, an "identity" sheet template is loaded. It is used to create a character with basic informations easly without adding all sheets one by one.
this template map contains all basic data for a simple character.
TODO: move this class into an appropriate ts file.
A character object contain all boxes and all sheets from a project's character. It is mainly used to store data using the config manager.
It inherites the HashFile class, this way it can be saved using it's own hash.
(string)
A reference to the plugin manager.
(any)
(boolean
= true)
Is the plugin required to function properly ?
Extends Plugin_1.Plugin
Load the configuration for the first time or from a file.
Get if user allow font search or not.
bool:
.
Set values for the choice of font automatic search
(bool)
choice of the user.
Removes the oldest recent path opened.
Saves the configuration to a file.
Purges all configuration files and recreate them from scratch.
FIXME: this method is temporary. To be placed into the editor plugin. Load text from a file path.
(any)
Extends Plugin_1.Plugin
Register a context menu into electron's internals and a callback when the menu is triggered on the specified element.
(string)
The element on wich the callback will be fired on a '@contextmenu' event.
(Menu)
The menu to display when '@contextmenu' is triggered.
Extends Plugin_1.Plugin
copy the special character to the clipboard. this function is called when the caractere can not be insert to the current editor.
(any)
Confirme the closure of a tab.
(any)
(any)
Extends Error
(any)
Extends Error
(any)
Extends Error
(any)
Extends Error
(any)
Extends Error
(any)
Extends Plugin_1.Plugin
Extends Plugin_1.Plugin
ask the current buffer to give it's content and then saving it to the disk.
does the same as the saveCurrentBuffer method but asks all opened buffers their content.
Load ideas from the disk
any:
the array of ideas
Load tags from the disk
any:
an array of tags
Load the todolist, don't need a path since there is only one todolist
any:
a lists of all tasks in the todolist
Recursively collect all the files in a directory and its subdirs
(any)
the path of a directory
(any)
an array of files, if empty it's the first call
otherwise it's a recursive call with files from upper or neighbor directories
any:
an array of all the files in a directory (recursively)
Take a list of text paths, read all the files and store them into a list
(any)
Paths of all texts actually associated to a chapter, still organized by chapter
any:
a list of the content of all the files (still ordered by chapter)
Remove a file based on its datastructure
(any)
datastructure of the file to be removed
Remove a file directly from its path
(any)
Save the content of the chronology on the disk
(any)
array of events of the story
any:
a confirmation or not that it has been saved
Save todo list on the disk
(any)
list of the tasks
any:
a confirmation or not that it has been saved
Save tags on the disk
(any)
array of tags to be saved
any:
a confirmation or not that it has been saved
Load chapters and drafts from a single file and return its content
(any)
directory where chapters are loaded
(any)
path of chapters inside that dir
any:
the content from the file as a string, ready to be JSON.parsed
(any)
list of chapters and their associated texts
(any)
list of remaining textes considered as draft
any:
a boolean true if chapters have been saved and false otherwise
Save settings on the disk
(any)
settings to be saved
any:
a confirmation or nor that it has been saved
Save a map to the disk
(any)
the map to be saved
any:
a confirmation or not that it has been saved
Save post-its on the disk in a single file
(any)
an array of all the post-its to be saved
any:
a confirmation or not that they were saved
Save ideas on the disk
(any)
array of ideas to be saved
any:
a confirmation or not that they were all saved
Save the body into an html file, read that file and convert it to pdf, save the pdf file and erase the temporary html file
(any)
html body received from the front
Create a folder
(any)
path of the new folder
Create a file and add some content if the argument is specified
(any)
path of the file to be created
(any
= "")
original content of the file
Ask to reload the source tree from the back
Generate a hash for a filename
any:
a hash to be used as a unique filename
Extends Plugin_1.Plugin
write css file for current fonts.
ask to the user if he authorize the fonts research. Do so in case of positive answer.
read the front from the user system
Extends Plugin_1.Plugin
Listener that creates the main window when electron is ready.
Listener that creates the main window if the activate signal is received.
Listener that creates the main window if the activate signal is received.
Creates the file protocol used by Grimoire to fetch files on the system.
Creates a new Electron window.
Listener that check if editors are still dirty before quitting a window
(any)
activate safe saving mode it means you set callback on the cross button, when editors are still dirty in the software
(any)
if you activate or desactivate the safe mode
Turn off the app.
(any
= false)
TODO: restrain the use of the window.
Get the _mainWindow instance of the app.
Asking the user for a file path using the dialog api.
(string)
Title of the dialog page.
(string)
message of the dialog page.
(string)
default path of the file to save.
Promise<string>:
returns the path choosen by the user.
any:
a boolean if the dark mode is activated.
sends feedback to Grimoire's servers.
(any)
(any)
Extends Plugin_1.Plugin
send a menu command to the front.
(any)
(any
= null)
load a text from a menu button.
create a menu template and returns it.
(Menu | null):
The new menu or null if the method failed.
Append every new recently opened path to the current menu.
(Menu)
The current menu.
Menu:
The updated menu.
Create or update an instance of the menu.
Extends Plugin_1.Plugin
Called when the renderer needs data on all projects.
(IpcMainEvent)
The event object to reply to the ipc.
Set a function called by the main process when the render process request a file path to import text in the project.
(IpcMainEvent)
The event object to reply to the ipc.
! This listener doesn't need a function because it won't be called ! without the ipc. It won't be used by other plugins.
Set a function called by the main process when the render process send information from the project creation
called by the front end when it needs the project's source tree.
(IpcMainEvent)
The event object to reply to the ipc.
Search for a project using the dialog api and opens it.
Get a tree architecture of files of the project, with their type, path and title.
(string
= this._currentProjectPath)
the path to the project folder.
(GFile)
the parent folder if there is one (used to call the method recursivly).
GFile:
the root folder of the project.
load character from json to Character.
Extends Image
(MouseEvent)
event trigger by the event.
(MouseEvent)
event trigger by the event.
(boolean)
if crop mode is activate or not.
(string)
new cursor you want
(string)
the new clip path stringified.
changes the theme of tippy instance.
(Instance)
tippy.js instance.
(string)
the theme to apply.
changes all themes from a set of tippy instance.
Extends vue_property_decorator_1.Mixins(AudioUploader_1.default)
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Mixins(ImageUploader_1.default)
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Mixins(ImageUploader_1.default)
Extends vue_property_decorator_1.Mixins(Editor_1.default)
(string)
new name you want to give to a tag.
update the name of a tab.
Extends vue_property_decorator_1.Mixins(AudioUploader_1.default)
Extends vue_property_decorator_1.Vue
(any)
if the quit button have to be display on the event or not
any:
True if the element is a period
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Mixins(Editor_1.default)
(any)
new chapter object
(any)
Id of the event to update
(any)
force a save, without timeout.
save an idea. Note that there is a timeout to avoid too much saving
(any)
id of the idea to remove.
remove an idea of the list.
(any)
id of the idea to remove.
remove an idea of the list.
(any)
id of the idea to update.
update an idea of the list and save the content.
Try to connect a user to the database.
! To be replaced with a database management with ! passwords stored as sha256.
Extends vue_property_decorator_1.Vue
(any)
VueColor object sent by the component
update the color of the post-it
(any)
force a save, without timeout.
save an idea. Note that there is a timeout to avoid too much saving
(any)
id of the post-it to remove
remove a post-it to the list of post-it
(any)
post-it to update
update the content of a post-it
(any)
id of the post-it to move.
(any)
shift in x dimension.
(any)
shift in y direction.
change the position of the post-it.
Sort lines of the project table from the index of the header.
(number)
The index of the header to sort.
Extends vue_property_decorator_1.Vue
Extends vue_property_decorator_1.Vue
callback for context-menu events. register an event listener on an element, triggers a callback when '@contextmenu' is called.
(string)
the name of the element.
(HTMLElement)
the element to register events to.
((ContextMenuDataCallback | null)
= null)
a callback to provide data to the backend when '@contextmenu' is fired.