Commit c4f0a05a authored by Daiki Ueno's avatar Daiki Ueno

Add valadoc comment to each public class.

https://bugzilla.gnome.org/show_bug.cgi?id=687244
parent 89b918df
namespace Caribou {
/**
* Object representing a column in a row.
*/
public class ColumnModel : ScannableGroup, IScannableItem, IKeyboardObject {
public bool scan_stepping { get; set; }
public bool scan_selected { get; set; }
......
namespace Caribou {
/**
* Object representing a group in a keyboard.
*
* This is used for implementing custom keyboard service.
*
* A group object consists of {@link LevelModel} objects.
*/
public class GroupModel : Object, IKeyboardObject {
public string active_level { get; private set; }
......
namespace Caribou {
/**
* Common interface providing access to keys.
*
* This is implemented by all the keyboard components.
*/
public interface IKeyboardObject : Object {
public abstract IKeyboardObject[] get_children ();
......
namespace Caribou {
/**
* Interface implemented by containers of selectable items in scanning mode.
*/
public interface IScannableGroup : Object {
public abstract IScannableItem? child_select ();
public abstract void scan_reset ();
......
namespace Caribou {
/**
* Interface implemented by items that can be selected in scanning mode.
*/
public interface IScannableItem : Object {
public abstract bool scan_stepping { get; set; }
public abstract bool scan_selected { get; set; }
......
namespace Caribou {
/**
* Object representing a key in a column.
*
* This is used for implementing custom keyboard service.
*/
public class KeyModel : GLib.Object, IScannableItem, IKeyboardObject {
public string align { get; set; default = "center"; }
public double width { get; set; default = 1.0; }
......
namespace Caribou {
/**
* Object representing a whole keyboard.
*
* This is used for implementing custom keyboard service.
*
* A keyboard object consists of {@link GroupModel} objects.
*/
public class KeyboardModel : Object, IKeyboardObject {
public string active_group { get; private set; default = ""; }
public string keyboard_type { get; construct; }
......
namespace Caribou {
/**
* Base abstract class of the Caribou D-Bus service.
*/
[DBus(name = "org.gnome.Caribou.Keyboard")]
public abstract class KeyboardService : Object {
public abstract void set_cursor_location(int x, int y, int w, int h);
......
namespace Caribou {
/**
* Object representing a level in a group.
*
* This is used for implementing custom keyboard service.
*
* A keyboard object consists of {@link RowModel} objects.
*/
public class LevelModel : ScannableGroup, IKeyboardObject {
public signal void level_toggled (string new_level);
public string mode { get; private set; default = ""; }
......
namespace Caribou {
/**
* Object representing a row in a level.
*
* This is used for implementing custom keyboard service.
*
* A keyboard object consists of {@link ColumnModel} objects.
*/
public class RowModel : ScannableGroup, IScannableItem, IKeyboardObject {
public bool scan_stepping { get; set; }
public bool scan_selected { get; set; }
......
namespace Caribou {
/**
* Base abstract class that implements scanning mode containers.
*/
public abstract class ScannableGroup : Object, IScannableGroup {
private Gee.LinkedList<IScannableItem> _step_path;
private Gee.LinkedList<IScannableItem> _selected_path;
......
namespace Caribou {
/**
* Object providing access to keyboard in scanning mode.
*/
public class Scanner : Object {
public bool bind_settings { get; construct; default=true; }
......
namespace Caribou {
/**
* Singleton object providing access to the X Window facility.
*/
public class XAdapter : Object {
/* Signals */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment