added interface headers with latest discussed changes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
110
interface/statbmp.h
Normal file
110
interface/statbmp.h
Normal file
@@ -0,0 +1,110 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: statbmp.h
|
||||
// Purpose: documentation for wxStaticBitmap class
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxStaticBitmap
|
||||
@wxheader{statbmp.h}
|
||||
|
||||
A static bitmap control displays a bitmap. It is meant for display of the
|
||||
small icons in the dialog boxes and is not meant to be a general purpose image
|
||||
display control. In particular, under Windows 9x the size of bitmap is limited
|
||||
to 64*64 pixels and thus you should use your own control if you want to
|
||||
display larger images portably.
|
||||
|
||||
@library{wxcore}
|
||||
@category{ctrl}
|
||||
@appearance{staticbitmap.png}
|
||||
|
||||
@seealso
|
||||
wxStaticBitmap, wxStaticBox
|
||||
*/
|
||||
class wxStaticBitmap : public wxControl
|
||||
{
|
||||
public:
|
||||
//@{
|
||||
/**
|
||||
Constructor, creating and showing a static bitmap control.
|
||||
|
||||
@param parent
|
||||
Parent window. Should not be @NULL.
|
||||
|
||||
@param id
|
||||
Control identifier. A value of -1 denotes a default value.
|
||||
|
||||
@param label
|
||||
Bitmap label.
|
||||
|
||||
@param pos
|
||||
Window position.
|
||||
|
||||
@param size
|
||||
Window size.
|
||||
|
||||
@param style
|
||||
Window style. See wxStaticBitmap.
|
||||
|
||||
@param name
|
||||
Window name.
|
||||
|
||||
@sa Create()
|
||||
*/
|
||||
wxStaticBitmap();
|
||||
wxStaticBitmap(wxWindow* parent, wxWindowID id,
|
||||
const wxBitmap& label,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = 0,
|
||||
const wxString& name = "staticBitmap");
|
||||
//@}
|
||||
|
||||
/**
|
||||
Creation function, for two-step construction. For details see wxStaticBitmap().
|
||||
*/
|
||||
bool Create(wxWindow* parent, wxWindowID id,
|
||||
const wxBitmap& label,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = 0,
|
||||
const wxString& name = "staticBitmap");
|
||||
|
||||
/**
|
||||
Returns the bitmap currently used in the control. Notice that this method can
|
||||
be called even if SetIcon() had been used.
|
||||
|
||||
@sa SetBitmap()
|
||||
*/
|
||||
wxBitmap GetBitmap();
|
||||
|
||||
/**
|
||||
Returns the icon currently used in the control. Notice that this method can
|
||||
only be called if SetIcon() had been used: an icon
|
||||
can't be retrieved from the control if a bitmap had been set (using
|
||||
wxStaticBitmap::SetBitmap).
|
||||
|
||||
@sa SetIcon()
|
||||
*/
|
||||
wxIcon GetIcon();
|
||||
|
||||
/**
|
||||
Sets the bitmap label.
|
||||
|
||||
@param label
|
||||
The new bitmap.
|
||||
|
||||
@sa GetBitmap()
|
||||
*/
|
||||
virtual void SetBitmap(const wxBitmap& label);
|
||||
|
||||
/**
|
||||
Sets the label to the given icon.
|
||||
|
||||
@param label
|
||||
The new icon.
|
||||
*/
|
||||
virtual void SetIcon(const wxIcon& label);
|
||||
};
|
||||
Reference in New Issue
Block a user