mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lokdocview, tilebuffer: Add DOxygen comments

Browse Source 
Change-Id: I27377f0a758729a7877cfc6a56ea1b4bb3d1c3c9
This commit is contained in:
Pranav Kant 2015-07-22 20:25:36 +05:30 committed by Miklos Vajna
parent 4edbf5a01f
commit e032b64451
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
libreofficekit/source/gtk/lokdocview.cxx
View File

@ -36,6 +36,7 @@
// Number of handles around a graphic selection. // Number of handles around a graphic selection.
#define GRAPHIC_HANDLE_COUNT 8 #define GRAPHIC_HANDLE_COUNT 8
/// Private struct used by this GObject type
struct _LOKDocViewPrivate struct _LOKDocViewPrivate
{ {
gchar* m_aLOPath; gchar* m_aLOPath;
@ -162,6 +163,7 @@ G_DEFINE_TYPE_WITH_CODE (LOKDocView, lok_doc_view, GTK_TYPE_DRAWING_AREA,
static GThreadPool* lokThreadPool; static GThreadPool* lokThreadPool;
/// Helper struct used to pass the data from soffice thread -> main thread.
struct CallbackData struct CallbackData
{ {
int m_nType; int m_nType;
@ -174,8 +176,16 @@ struct CallbackData
m_pDocView(pDocView) {} m_pDocView(pDocView) {}
}; };
/**
A struct that we use to store the data about the LOK call.
Object of this type is passed with all the LOK calls,
so that they can be idenitified. Additionally, it also contains
the data that LOK call needs.
*/
struct LOEvent struct LOEvent
{ {
/// To identify the type of LOK call
int m_nType; int m_nType;
const gchar* m_pCommand; const gchar* m_pCommand;
const gchar* m_pArguments; const gchar* m_pArguments;
@ -187,6 +197,8 @@ struct LOEvent
int m_nCharCode; int m_nCharCode;
int m_nKeyCode; int m_nKeyCode;
/// Constructor to easily instantiate an object for LOK call of `type' type.
LOEvent(int type) LOEvent(int type)
: m_nType(type) {} : m_nType(type) {}

5
libreofficekit/source/gtk/tilebuffer.hxx
View File

@ -131,6 +131,11 @@ class TileBuffer
Tile m_DummyTile; Tile m_DummyTile;
}; };
/**
Helper struct used to pass the data from main thread to spawned threads.
Spawned threads are responsible for calling paintTile, and store the result
in tile buffer.
*/
struct GetTileCallbackData struct GetTileCallbackData
{ {
int m_nX; int m_nX;