diff options
author | Joas Schilling <coding@schilljs.com> | 2017-01-19 12:34:17 +0300 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2017-01-19 12:42:21 +0300 |
commit | 8c8354399a1923b3580bf887f1f0ab1ef50bc14e (patch) | |
tree | 1134a1732816e7d54ce6909472e366af7bf93b19 /lib/public/Settings | |
parent | 381e58d7d4c5b04f32cdbec813ec2a2d150e09bc (diff) |
Allow apps to specify an icon with the sections via the API
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'lib/public/Settings')
-rw-r--r-- | lib/public/Settings/IIconSection.php | 38 | ||||
-rw-r--r-- | lib/public/Settings/ISection.php | 1 |
2 files changed, 39 insertions, 0 deletions
diff --git a/lib/public/Settings/IIconSection.php b/lib/public/Settings/IIconSection.php new file mode 100644 index 00000000000..089b9b094e9 --- /dev/null +++ b/lib/public/Settings/IIconSection.php @@ -0,0 +1,38 @@ +<?php +/** + * @copyright Copyright (c) 2017, Joas Schilling <coding@schilljs.com> + * + * @author Joas Schilling <coding@schilljs.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Settings; + +/** + * @since 12 + */ +interface IIconSection extends ISection { + /** + * returns the relative path to an 16*16 icon describing the section. + * e.g. '/core/img/places/files.svg' + * + * @returns string + * @since 12 + */ + public function getIcon(); +} diff --git a/lib/public/Settings/ISection.php b/lib/public/Settings/ISection.php index 5edf5de0ca4..3c08b74bdc9 100644 --- a/lib/public/Settings/ISection.php +++ b/lib/public/Settings/ISection.php @@ -24,6 +24,7 @@ namespace OCP\Settings; /** + * @deprecated 12 Use IIconSection instead * @since 9.1 */ interface ISection { |