libyui  3.0.10
 All Classes Functions Variables Enumerations Friends
YFrame.h
1 /*
2  Copyright (C) 2000-2012 Novell, Inc
3  This library is free software; you can redistribute it and/or modify
4  it under the terms of the GNU Lesser General Public License as
5  published by the Free Software Foundation; either version 2.1 of the
6  License, or (at your option) version 3.0 of the License. This library
7  is distributed in the hope that it will be useful, but WITHOUT ANY
8  WARRANTY; without even the implied warranty of MERCHANTABILITY or
9  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
10  License for more details. You should have received a copy of the GNU
11  Lesser General Public License along with this library; if not, write
12  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
13  Floor, Boston, MA 02110-1301 USA
14 */
15 
16 
17 /*-/
18 
19  File: YFrame.h
20 
21  Author: Stefan Hundhammer <sh@suse.de>
22 
23 /-*/
24 
25 #ifndef YFrame_h
26 #define YFrame_h
27 
28 #include <string>
29 #include "YSingleChildContainerWidget.h"
30 #include "ImplPtr.h"
31 
32 class YFramePrivate;
33 
34 
36 {
37 protected:
38  /**
39  * Constructor.
40  **/
41  YFrame( YWidget * parent, const std::string & label );
42 
43 public:
44  /**
45  * Destructor.
46  **/
47  virtual ~YFrame();
48 
49  /**
50  * Returns a descriptive name of this widget class for logging,
51  * debugging etc.
52  **/
53  virtual const char * widgetClass() const { return "YFrame"; }
54 
55  /**
56  * Change the frame label.
57  *
58  * Derived classes should overwrite this, but call this base class function
59  * in the overwritten function.
60  **/
61  virtual void setLabel( const std::string & newLabel );
62 
63  /**
64  * Get the current frame label.
65  **/
66  std::string label() const;
67 
68  /**
69  * Set a property.
70  * Reimplemented from YWidget.
71  *
72  * This method may throw exceptions, for example
73  * - if there is no property with that name
74  * - if the expected type and the type mismatch
75  * - if the value is out of range
76  *
77  * This function returns 'true' if the value was successfully set and
78  * 'false' if that value requires special handling (not in error cases:
79  * those are covered by exceptions).
80  **/
81  virtual bool setProperty( const std::string & propertyName,
82  const YPropertyValue & val );
83 
84  /**
85  * Get a property.
86  * Reimplemented from YWidget.
87  *
88  * This method may throw exceptions, for example
89  * - if there is no property with that name
90  **/
91  virtual YPropertyValue getProperty( const std::string & propertyName );
92 
93  /**
94  * Return this class's property set.
95  * This also initializes the property set upon the first call.
96  *
97  * Reimplemented from YWidget.
98  **/
99  virtual const YPropertySet & propertySet();
100 
101 
102 private:
103 
105 };
106 
107 
108 #endif // YFrame_h
YFrame(YWidget *parent, const std::string &label)
Definition: YFrame.cc:45
virtual ~YFrame()
Definition: YFrame.cc:53
YWidget * parent() const
Definition: YWidget.cc:269
virtual void setLabel(const std::string &newLabel)
Definition: YFrame.cc:59
virtual bool setProperty(const std::string &propertyName, const YPropertyValue &val)
Definition: YFrame.cc:91
Definition: YFrame.h:35
virtual const char * widgetClass() const
Definition: YFrame.h:53
virtual YPropertyValue getProperty(const std::string &propertyName)
Definition: YFrame.cc:106
virtual const YPropertySet & propertySet()
Definition: YFrame.cc:72
std::string label() const
Definition: YFrame.cc:65