-
Notifications
You must be signed in to change notification settings - Fork 47
Internal Documentation Index
Mike Medley edited this page May 15, 2023
·
3 revisions
The pages listed here are purely for documenting the guts of GM_config. This documentation is not intended for those who wish to use GM_config as a library, but rather those who want join the in the development of GM_config and help improve it.
-
The constructor for the main object users user to interact with GM_config.
-
- Allow support for old api usage. It just calls GM_configInit now.
- Does all the DOM building and paints the GUI to the frame.
- Reads in all the values from the GUI and saves them to persistent storage.
- Removes the GUI from the page.
- API method for directly setting one of the values stored internally.
- API method for directly accessing one of the values stored internally.
- Writes all field values to persistent storage.
- Reads all field values from persistent storage.
- Makes all fields in the GUI return to their previously saved values.
- A helper function that allows for easy creation of DOM Elements.
- Keeps the GUI centered in the window when the window is re-sized.
- A helper function to remove an element from the DOM.
-
- A callback method that is called on the GUI has been painted to the frame.
- A callback method that is called once field values have been written to persistent storage.
- A callback method that is called once the GUI has been removed from the page.
- A callback method that is called once the fields in the GUI have been restored to their previously saved values.
- A unique id for this instance of GM_configStruct.
- Where we store the collection of GM_configStruct objects.
- The title text used for the GUI.
- The object we use to store both the basic and custom css for the GUI.
-
- The function we use to initialize a newly created GM_configField object.