naughty: do not export documentation of local functions
[awesome.git] / tag.h
blob88eb7cc03f4c0e35a024e59878d3a7370f8a8449
1 /*
2 * tag.h - tag management header
4 * Copyright © 2007-2008 Julien Danjou <julien@danjou.info>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #ifndef AWESOME_TAG_H
23 #define AWESOME_TAG_H
25 #include "structs.h"
26 #include "client.h"
27 #include "common/refcount.h"
29 /* Contructor, destructor and referencors */
30 tag_t *tag_new(const char *, ssize_t);
32 static inline void
33 tag_delete(tag_t **tag)
35 client_array_wipe(&(*tag)->clients);
36 p_delete(&(*tag)->name);
37 p_delete(tag);
40 tag_t **tags_get_current(int);
41 void tag_client(client_t *, tag_t *);
42 void untag_client(client_t *, tag_t *);
43 bool is_client_tagged(client_t *, tag_t *);
44 void tag_view_only_byindex(int, int);
45 void tag_append_to_screen(tag_t *, screen_t *);
46 int luaA_tag_userdata_new(lua_State *, tag_t *);
48 DO_RCNT(tag_t, tag, tag_delete)
49 ARRAY_FUNCS(tag_t *, tag, tag_unref);
51 #endif
52 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80