brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[layout, docs] Document FixedLayout

Browse Source
This commit is contained in:
Emmanuele Bassi 2009-09-16 11:10:38 +01:00
parent aaae60e178
commit c6f67bf872
2 changed files with 87 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
clutter/clutter-fixed-layout.c
View File

@ -1,3 +1,39 @@
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2009 Intel Corporation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author:
* Emmanuele Bassi <ebassi@linux.intel.com>
*
* Based on the fixed layout code inside clutter-group.c
*/
/**
* SECTION:clutter-fixed-layout
* @short_description: A fixed layout manager
*
* #ClutterFixedLayout is a layout manager implementing the same
* layout policies as #ClutterGroup.
*
* #ClutterFixedLayout is available since Clutter 1.2
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif #endif
@ -210,6 +246,15 @@ clutter_fixed_layout_init (ClutterFixedLayout *self)
{ {
} }
/**
* clutter_fixed_layout_new:
*
* Creates a new #ClutterFixedLayout
*
* Return value: the newly created #ClutterFixedLayout
*
* Since: 1.2
*/
ClutterLayoutManager * ClutterLayoutManager *
clutter_fixed_layout_new (void) clutter_fixed_layout_new (void)
{ {

42
clutter/clutter-fixed-layout.h
View File

@ -1,3 +1,27 @@
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2009 Intel Corporation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author:
* Emmanuele Bassi <ebassi@linux.intel.com>
*/
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION) #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly." #error "Only <clutter/clutter.h> can be included directly."
#endif #endif
@ -19,13 +43,31 @@ G_BEGIN_DECLS
typedef struct _ClutterFixedLayout ClutterFixedLayout; typedef struct _ClutterFixedLayout ClutterFixedLayout;
typedef struct _ClutterFixedLayoutClass ClutterFixedLayoutClass; typedef struct _ClutterFixedLayoutClass ClutterFixedLayoutClass;
/**
* ClutterFixedLayout:
*
* The #ClutterFixedLayout structure contains only private data and
* it should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterFixedLayout struct _ClutterFixedLayout
{ {
/*< private >*/
ClutterLayoutManager parent_instance; ClutterLayoutManager parent_instance;
}; };
/**
* ClutterFixedLayoutClass:
*
* The #ClutterFixedLayoutClass structure contains only private data
* and it should be accessed using the provided API
*
* Since: 1.2
*/
struct _ClutterFixedLayoutClass struct _ClutterFixedLayoutClass
{ {
/*< private >*/
ClutterLayoutManagerClass parent_class; ClutterLayoutManagerClass parent_class;
}; };