wxPGEditableState Class Reference
#include <propgrid.h>
Inheritance diagram for wxPGEditableState:
Detailed Description
Contains information about wxPropertyGrid's user-editable state, as returned by wxPropertyGrid::SaveEditableState().Public Types | |
| enum | IncludeFlags { Selection = 0x01, Expanded = 0x02, ScrollPos = 0x04, Page = 0x08, SplitterPos = 0x10, All = Selection | Expanded | ScrollPos | Page | SplitterPos } |
Public Member Functions | |
| wxString | GetAsString () const |
| const wxArrayString & | GetExpanded () const |
| wxPoint | GetScrollPos () const |
| const wxString & | GetSelection () const |
| const wxArrayInt & | GetSplitterPos () const |
| int | HasFlag (int flag) const |
| void | SetExpanded (const wxPropertyContainerMethods *propIface) |
| bool | SetFromString (const wxString &str) |
| void | SetScrollPos (int h, int v) |
| void | SetSelection (const wxString &selection) |
| void | SetSplitterPos (int pos) |
| wxPGEditableState (const wxString &str) | |
| wxPGEditableState (const wxPropertyGrid *pg, int includedState=All) | |
| wxPGEditableState () | |
| virtual | ~wxPGEditableState () |
Protected Attributes | |
| wxArrayString | m_expanded |
| int | m_flags |
| int | m_hScrollPos |
| int | m_page |
| wxString | m_selection |
| wxArrayInt | m_splitterPos |
| int | m_vScrollPos |
Member Enumeration Documentation
Flags to be used with wxPropertyGrid::SaveEditableState().
- Enumerator:
-
Selection Include selected property. Expanded Include expanded/collapsed property information. ScrollPos Include scrolled position. Page Include selected page information. Only applies to wxPropertyGridManager.
SplitterPos Include splitter position. Stored for each page.
All Include all supported user editable state information. This is usually the default value.
Constructor & Destructor Documentation
| wxPGEditableState::wxPGEditableState | ( | ) |
Constructor.
| wxPGEditableState::wxPGEditableState | ( | const wxPropertyGrid * | pg, | |
| int | includedState = All | |||
| ) |
Constructor.
| wxPGEditableState::wxPGEditableState | ( | const wxString & | str | ) |
Constructor.
| virtual wxPGEditableState::~wxPGEditableState | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| wxString wxPGEditableState::GetAsString | ( | ) | const |
Encodes state information in a string.
- Remarks:
- String is not guaranteed to have any particular format, except one that should be readable by SetFromString().
| bool wxPGEditableState::SetFromString | ( | const wxString & | str | ) |
Decodes state information from a string.
- Return values:
-
Returns true if string was read properly. On false, wxPGEditableState will remain in undefined state.
The documentation for this class was generated from the following file:
- propgrid.h
