docs/buxton-api.7

   1 '\" t
   2 .TH "BUXTON\-API" "7" "" "buxton 1" "buxton\-api"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 buxton\-api \- List of all Buxton API functions
  24
  25 .SH "DESCRIPTION"
  26 .PP
  27 This document contains the complete list of buxton API functions,
  28 each having its own manual page\&.
  29
  30 In addition, there are several "hello world" demo programs in the
  31 buxton source tree, in the demos/ directory, that demonstrate how to
  32 use these API functions\&.
  33
  34 .SH "API functions"
  35 .SS "Client connections"
  36 .PP
  37 \fBbuxton_open\fR(3)
  38 \(em Open a buxton client connection
  39 .br
  40 \fBbuxton_close\fR(3)
  41 \(em Close a buxton client connection
  42 .br
  43
  44 .SS "BuxtonKey utility functions"
  45 .PP
  46 \fBbuxton_key_create\fR(3)
  47 \(em Create a client\-side key (BuxtonKey)
  48 .br
  49 \fBbuxton_key_free\fR(3)
  50 \(em Free a BuxtonKey
  51 .br
  52 \fBbuxton_key_get_type\fR(3)
  53 \(em Get the type member of a BuxtonKey
  54 .br
  55 \fBbuxton_key_get_layer\fR(3)
  56 \(em Get the layer member of a BuxtonKey
  57 .br
  58 \fBbuxton_key_get_group\fR(3)
  59 \(em Get a group member of a BuxtonKey
  60 .br
  61 \fBbuxton_key_get_name\fR(3)
  62 \(em Get a name member of a BuxtonKey
  63 .br
  64
  65 .SS "Group storage and manipulation"
  66 .PP
  67 \fBbuxton_create_group\fR(3)
  68 \(em Create a group within a layer
  69 .br
  70 \fBbuxton_remove_group\fR(3)
  71 \(em Remove a group within a layer
  72 .br
  73 \fBbuxton_set_label\fR(3)
  74 \(em Set the Smack label for a group
  75 .br
  76
  77 .SS "Key storage and manipulation"
  78 .PP
  79 \fBbuxton_set_value\fR(3)
  80 \(em Set the value for a key
  81 .br
  82 \fBbuxton_get_value\fR(3)
  83 \(em Get the value of a key
  84 .br
  85 \fBbuxton_unset_value\fR(3)
  86 \(em Unset the value for a key
  87 .br
  88 \fBbuxton_set_label\fR(3)
  89 \(em Set the Smack label for a key
  90 .br
  91
  92 .SS "Notifications"
  93 .PP
  94 \fBbuxton_register_notification\fR(3)
  95 \(em Register for a key notification
  96 .br
  97 \fBbuxton_unregister_notification\fR(3)
  98 \(em Unregister for a key notification
  99 .br
 100 \fBbuxton_handle_response\fR(3)
 101 \(em Notification response helper
 102 .br
 103
 104 .SS "Callbacks"
 105 .PP
 106 \fBbuxton_response_status\fR(3)
 107 \(em Get the status for a BuxtonResponse in a callback
 108 .br
 109 \fBbuxton_response_key\fR(3)
 110 \(em Fetch the BuxtonKey within a callback
 111 .br
 112 \fBbuxton_response_type\fR(3)
 113 \(em Fetch the response type within a callback
 114 .br
 115 \fBbuxton_response_value\fR(3)
 116 \(em Fetch the response value within a callback
 117 .br
 118
 119 .SS "Configuration"
 120 .PP
 121 \fBbuxton_set_conf_file\fR(3)
 122 \(em Set the path to the Buxton configuration file
 123 .br
 124
 125 .SH "COPYRIGHT"
 126 .PP
 127 Copyright 2014 Intel Corporation\&. License: Creative Commons
 128 Attribution\-ShareAlike 3.0 Unported\s-2\u[1]\d\s+2\&.
 129
 130 .SH "SEE ALSO"
 131 .PP
 132 \fBbuxton\fR(7)
 133
 134 .SH "NOTES"
 135 .IP " 1." 4
 136 Creative Commons Attribution\-ShareAlike 3.0 Unported
 137 .RS 4
 138 \%http://creativecommons.org/licenses/by-sa/3.0/
 139 .RE