LatexilaUtils

LatexilaUtils — Utilities functions

Functions

Includes

#include <latexila.h>

Description

Various utilities functions.

Functions

latexila_utils_get_shortname ()

gchar *
latexila_utils_get_shortname (const gchar *filename);

Parameters

filename

a filename.

 

Returns

the filename without its extension. Free with g_free().


latexila_utils_get_extension ()

gchar *
latexila_utils_get_extension (const gchar *filename);

Parameters

filename

a filename.

 

Returns

the filename 's extension with the dot, in lowercase. Free with g_free().


latexila_utils_replace_home_dir_with_tilde ()

gchar *
latexila_utils_replace_home_dir_with_tilde
                               (const gchar *filename);

Replaces the home directory with a tilde, if the home directory is present in the filename .

This function comes from gedit.

Parameters

filename

the filename.

 

Returns

the new filename. Free with g_free().


latexila_utils_register_icons ()

void
latexila_utils_register_icons (void);

Register the LaTeXila icons to the GtkIconTheme as built-in icons. For example the icon located at data/images/stock-icons/badbox.png in the LaTeXila git repository will be available with the icon name "badbox". The "stock-icons" directory name is for historical reasons and should be changed when stock icons are no longer used in LaTeXila.

TODO: prefix icon names with "latexila-", so the badbox.png would be "latexila-badbox". Also, put icons in subdirectories for each size, so it is better for icons available in several sizes. As an example there is currently table-size16.png and table-size24.png.


latexila_utils_str_replace ()

gchar *
latexila_utils_str_replace (const gchar *string,
                            const gchar *search,
                            const gchar *replacement);

Replaces all occurences of search by replacement .

Parameters

string

a string

 

search

the search string

 

replacement

the replacement string

 

Returns

A newly allocated string with the replacements. Free with g_free().


latexila_utils_file_query_exists_async ()

void
latexila_utils_file_query_exists_async
                               (GFile *file,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

The asynchronous version of g_file_query_exists(). When the operation is finished, callback will be called. You can then call latexila_utils_file_query_exists_finish() to get the result of the operation.

Parameters

file

a GFile.

 

cancellable

GCancellable.

 

callback

the callback to call when the operation is finished.

 

user_data

the data to pass to the callback function.

 

latexila_utils_file_query_exists_finish ()

gboolean
latexila_utils_file_query_exists_finish
                               (GFile *file,
                                GAsyncResult *result);

Finishes the operation started with latexila_utils_file_query_exists_async(). There is no output GError parameter, so you should check if the operation has been cancelled (in which case FALSE will be returned).

Parameters

file

a GFile.

 

result

a GAsyncResult.

 

Returns

TRUE if the file exists and the operation hasn't been cancelled, FALSE otherwise.


latexila_utils_show_uri ()

void
latexila_utils_show_uri (GdkScreen *screen,
                         const gchar *uri,
                         GError **error);

Shows the uri . If the URI is a PDF file and if Evince is the default document viewer, this function also connects the Evince window so the backward search works (switch from the PDF to the source file).

Parameters

screen

a GdkScreen, or NULL.

[nullable]

uri

the URI to show

 

error

a NULL GError, or NULL.

[out][optional]

Types and Values