openldev/openldev.h File Reference

OpenLDev. More...

#include "openldev-utils.h"
#include "openldev-menu-callbacks.h"
#include "openldev-widgets/openldev-goto-line-toolbar.h"
#include "openldev-widgets/openldev-find-toolbar.h"
#include "openldev-widgets/openldev-menu.h"
#include "openldev-widgets/openldev-file-manager.h"
#include "openldev-widgets/openldev-output-manager.h"
#include "openldev-widgets/openldev-sidebar.h"
#include "openldev-widgets/openldev-status-bar.h"
#include "openldev-settings/openldev-editor.h"
#include "openldev-settings/openldev-settings.h"
#include "openldev-settings/openldev-project.h"
#include "openldev-plugin.h"
#include <glib-object.h>
#include <glib.h>

Data Structures
struct	OpenLDev
	The central class for the application that handles all other widgets. More...
Defines
#define	VERSION   "0.6.0"
Functions
void	openldev_manage_menu_items (OpenLDev *openldev)
gboolean	openldev_open_file (OpenLDev *openldev, gchar *file)
gboolean	openldev_open_project (OpenLDev *openldev, gchar *file)
void	openldev_populate_treeview (OpenLDev *openldev)
void	openldev_goto_line_number (OpenLDev *openldev, int line_number)
void	openldev_find_and_replace (OpenLDev *openldev)
void	openldev_menu_file_close_project (OpenLDev *openldev)
void	openldev_menu_file_new_file (OpenLDev *openldev)
void	openldev_menu_file_new_project (OpenLDev *openldev)
void	openldev_menu_file_open (OpenLDev *openldev)
void	openldev_menu_file_print (OpenLDev *openldev)
void	openldev_menu_file_print_preview (OpenLDev *openldev)
void	openldev_menu_file_revert (OpenLDev *openldev)
void	openldev_menu_file_save (OpenLDev *openldev)
void	openldev_menu_file_save_all (OpenLDev *openldev)
void	openldev_menu_file_save_as (OpenLDev *openldev)
void	openldev_menu_edit_copy (OpenLDev *openldev)
void	openldev_menu_edit_cut (OpenLDev *openldev)
void	openldev_menu_edit_deselect (OpenLDev *openldev)
void	openldev_menu_edit_find (OpenLDev *openldev)
void	openldev_menu_edit_find_next (OpenLDev *openldev)
void	openldev_menu_edit_goto_line (OpenLDev *openldev)
void	openldev_menu_edit_paste (OpenLDev *openldev)
void	openldev_menu_edit_preferences (OpenLDev *openldev)
void	openldev_menu_edit_redo (OpenLDev *openldev)
void	openldev_menu_edit_select_all (OpenLDev *openldev)
void	openldev_menu_edit_undo (OpenLDev *openldev)
void	openldev_menu_project_info (OpenLDev *openldev)
void	openldev_menu_project_preferences (OpenLDev *openldev)
void	openldev_menu_build_auto_generate (OpenLDev *openldev)
void	openldev_menu_build_project (OpenLDev *openldev)
void	openldev_menu_build_clean (OpenLDev *openldev)
void	openldev_menu_build_compile (OpenLDev *openldev)
void	openldev_menu_build_configure (OpenLDev *openldev)
void	openldev_menu_build_execute (OpenLDev *openldev)
void	openldev_menu_build_stop (OpenLDev *openldev)
void	openldev_menu_view_browser (OpenLDev *openldev)
void	openldev_menu_view_line_numbering (OpenLDev *openldev)
void	openldev_menu_view_output (OpenLDev *openldev)
void	openldev_menu_view_statusbar (OpenLDev *openldev)
void	openldev_menu_view_toolbar (OpenLDev *openldev)
void	openldev_menu_help_documentation (OpenLDev *openldev)
void	openldev_menu_help_report_bug (OpenLDev *openldev)
void	openldev_menu_help_about (OpenLDev *openldev)

---

Detailed Description

---

Define Documentation

#define VERSION   "0.6.0"

The version of the release you are coding for.

---

Function Documentation

void openldev_find_and_replace (  OpenLDev *  openldev  )

The Find and Replace dialog is shown to the user. Parameters: openldev  The OpenLDev application object.

void openldev_goto_line_number (  OpenLDev *  openldev, int  line_number )

Jump to the specified line number of the current document. If there is no document open, nothing will be done. If -1 is passed to line_number, the Goto Line toolbar will be opened. Parameters: openldev  The OpenLDev application object. line_number  The line number to jump to or -1.

void openldev_manage_menu_items (  OpenLDev *  openldev  )

Every time files are opened or closed, this function must be called. It enables and disables menu and toolbar items as necessary. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_auto_generate (  OpenLDev *  openldev  )

Run the Automatic Generation command specified by the project. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_clean (  OpenLDev *  openldev  )

Run the Clean command specified by the project. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_compile (  OpenLDev *  openldev  )

Run the Compile command specified by the project. All instances of {FILE} in the command are replaced by the full path of the current file. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_configure (  OpenLDev *  openldev  )

Run the Configure (./configure) command specified by the project. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_execute (  OpenLDev *  openldev  )

Execute the binary built by the build command by the project. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_project (  OpenLDev *  openldev  )

Run the Build (make) command specified by the project. Parameters: openldev  The OpenLDev application object.

void openldev_menu_build_stop (  OpenLDev *  openldev  )

Stop any build command currently running. This excludes the Execute command. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_copy (  OpenLDev *  openldev  )

Copy any selected text in the current file on to the Clipboard. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_cut (  OpenLDev *  openldev  )

Copy any selected text in the current file on to the Clipboard and delete it from the buffer. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_deselect (  OpenLDev *  openldev  )

Unselect any selected text in the current file. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_find (  OpenLDev *  openldev  )

Open or close the Find toolbar. To actually search for text, you must call the "openldev_menu_edit_find_next" function. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_find_next (  OpenLDev *  openldev  )

Find the next occurrence of the specified string in the current file. If "Search all files" is selected, all source files will be searched and the output will be shown in the Search output tab. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_goto_line (  OpenLDev *  openldev  )

Show or hide the Goto Line toolbar. To actually jump to a line, you must call the "openldev_goto_to_line_number" function. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_paste (  OpenLDev *  openldev  )

Insert the text from the Clipboard into the current buffer. If there is selected text, it will be replaced. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_preferences (  OpenLDev *  openldev  )

Allow the user to edit general preferences for the application. These includes options for the editor, syntax highlighting and plugins. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_redo (  OpenLDev *  openldev  )

Redo the last action that was undone by the user. This is performed on the current file. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_select_all (  OpenLDev *  openldev  )

Select all of the text in the current file. Parameters: openldev  The OpenLDev application object.

void openldev_menu_edit_undo (  OpenLDev *  openldev  )

Undo the last action that was done by the user. This is performed on the current file. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_close_project (  OpenLDev *  openldev  )

Close the project that is currently open. If there is no project open, nothing will happen. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_new_file (  OpenLDev *  openldev  )

Show the dialog that allows the user to create a new file. If a new file is successfully created, it will be automatically opened in a new tab. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_new_project (  OpenLDev *  openldev  )

Show the dialog that allows the user to create a new project. If a new project is successfully created, it will be loaded in the editor and Auto Generate will be run. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_open (  OpenLDev *  openldev  )

Allow the user to choose a file or project to be opened in the editor. This is done using the GtkFileChooserDialog. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_print (  OpenLDev *  openldev  )

Show the print dialog for the current file. This function should not be called if no files are open. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_print_preview (  OpenLDev *  openldev  )

Show the print preview dialog for the current file. This function should not be called if no files are open. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_revert (  OpenLDev *  openldev  )

Revert to the saved version of a file. If the file as been modified, permission will be asked from the user before this is done. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_save (  OpenLDev *  openldev  )

Save the current file under its current file name. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_save_all (  OpenLDev *  openldev  )

Save all of the open files that have been modified since the last save. Parameters: openldev  The OpenLDev application object.

void openldev_menu_file_save_as (  OpenLDev *  openldev  )

Save the current file under a new file name. Parameters: openldev  The OpenLDev application object.

void openldev_menu_help_about (  OpenLDev *  openldev  )

Show the about dialog. This contains version, copyright and developer information. Parameters: openldev  The OpenLDev application object.

void openldev_menu_help_documentation (  OpenLDev *  openldev  )

Launch a browser containing the documentation web site. This will be done in the default Gnome web browser. Parameters: openldev  The OpenLDev application object.

void openldev_menu_help_report_bug (  OpenLDev *  openldev  )

Launch a browser containing the bug reporting web site. This will be done in the default Gnome web browser. Parameters: openldev  The OpenLDev application object.

void openldev_menu_project_info (  OpenLDev *  openldev  )

Show basic information about the current project such as the number of lines and files. Parameters: openldev  The OpenLDev application object.

void openldev_menu_project_preferences (  OpenLDev *  openldev  )

Allow the user to edit basic settings in their project such as build commands and version number. Parameters: openldev  The OpenLDev application object.

void openldev_menu_view_browser (  OpenLDev *  openldev  )

Show or hide the project file browser. This will happen to the whole GtkNotebook, so any plugins in another tab will also be shown or hidden. Parameters: openldev  The OpenLDev application object.

void openldev_menu_view_line_numbering (  OpenLDev *  openldev  )

Show or hide the line numbering in each of the open files. Parameters: openldev  The OpenLDev application object.

void openldev_menu_view_output (  OpenLDev *  openldev  )

Show or hide the project output manager. This will happen to the whole GtkNotebook, so any plugins in another tab will also be shown or hidden. Parameters: openldev  The OpenLDev application object.

void openldev_menu_view_statusbar (  OpenLDev *  openldev  )

Show or hide the status bar and progress bar. Parameters: openldev  The OpenLDev application object.

void openldev_menu_view_toolbar (  OpenLDev *  openldev  )

Show or hide the whole toolbar. Parameters: openldev  The OpenLDev application object.

gboolean openldev_open_file (  OpenLDev *  openldev, gchar *  file )

A file with the specified name is opened in a new tab of the FileManager. You must specify the full path of the file name. Parameters: openldev  The OpenLDev application object. file  The full path of a file that should be opened in a new tab. Returns: TRUE if the file was successfully opened.

gboolean openldev_open_project (  OpenLDev *  openldev, gchar *  file )

A project at the specified location is closed. If a project is already opened, it will first be closed. Parameters: openldev  The OpenLDev application object. file  The full path location of a project. Returns: TRUE if the project was successfully loaded.

void openldev_populate_treeview (  OpenLDev *  openldev  )

This is a convenience function that calls "openldev_browser_project_populate" on the current BrowserProject object. Parameters: openldev  The OpenLDev application object.

---