| CEGUIMultiColumnList.h | | CEGUIMultiColumnList.h | |
| | | | |
| skipping to change at line 727 | | skipping to change at line 727 | |
| Return the pixel width of the widest item in the given column | | Return the pixel width of the widest item in the given column | |
| */ | | */ | |
| float getWidestColumnItemWidth(uint col_idx) const; | | float getWidestColumnItemWidth(uint col_idx) const; | |
| | | | |
| /*! | | /*! | |
| \brief | | \brief | |
| Return, in pixels, the height of the highest item in the given row. | | Return, in pixels, the height of the highest item in the given row. | |
| */ | | */ | |
| float getHighestRowItemHeight(uint row_idx) const; | | float getHighestRowItemHeight(uint row_idx) const; | |
| | | | |
|
| | | /*! | |
| | | \brief | |
| | | Get whether or not column auto-sizing (autoSizeColumnHeader()) will | |
| | | use | |
| | | the list header segment size. | |
| | | | |
| | | \return | |
| | | Return true if the header segment will be included in the width | |
| | | calculation. | |
| | | */ | |
| | | bool getAutoSizeColumnUsesHeader() const; | |
| | | | |
| /*******************************************************************
****** | | /*******************************************************************
****** | |
| Manipulator Methods | | Manipulator Methods | |
| ********************************************************************
*****/ | | ********************************************************************
*****/ | |
| /*! | | /*! | |
| \brief | | \brief | |
| Initialise the Window based object ready for use. | | Initialise the Window based object ready for use. | |
| | | | |
| \note | | \note | |
| This must be called for every window created. Normally this
is handled automatically by the WindowFactory for each Window type. | | This must be called for every window created. Normally this
is handled automatically by the WindowFactory for each Window type. | |
| | | | |
| | | | |
| skipping to change at line 1261 | | skipping to change at line 1272 | |
| \param row_id | | \param row_id | |
| ID code to be assigned to the row at the requested index. | | ID code to be assigned to the row at the requested index. | |
| | | | |
| \return | | \return | |
| Nothing. | | Nothing. | |
| | | | |
| \exception InvalidRequestException thrown if \a row_idx is out
of range | | \exception InvalidRequestException thrown if \a row_idx is out
of range | |
| */ | | */ | |
| void setRowID(uint row_idx, uint row_id); | | void setRowID(uint row_idx, uint row_id); | |
| | | | |
|
| | | /*! | |
| | | \brief | |
| | | Ensure the specified item is made visible within the multi-column | |
| | | listbox. | |
| | | | |
| | | \param item | |
| | | Pointer to the ListboxItem to be made visible in the multi-column | |
| | | listbox. | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | | |
| | | \exception InvalidRequestException thrown if \a item is not attached t | |
| | | o | |
| | | this multicolumnlist. | |
| | | */ | |
| | | void ensureItemIsVisible(const ListboxItem* item); | |
| | | | |
| | | /*! | |
| | | \brief | |
| | | Ensure the item at the specified grid coordinate is visible within | |
| | | the | |
| | | multi-column listbox. | |
| | | | |
| | | \param grid_ref | |
| | | MCLGridRef object holding the grid coordinate that is to be made | |
| | | visible. | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | */ | |
| | | void ensureItemIsVisible(const MCLGridRef& grid_ref); | |
| | | | |
| | | /*! | |
| | | \brief | |
| | | Ensure that the row of the \a item is visible within the multi-colu | |
| | | mn | |
| | | listbox. | |
| | | | |
| | | \note | |
| | | This doesn't necessarily make \a item visible. | |
| | | | |
| | | \param item | |
| | | Pointer to the ListboxItem whose row is to be made visible in the | |
| | | multi-column listbox. | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | */ | |
| | | void ensureItemRowIsVisible(const ListboxItem* item); | |
| | | | |
| | | /*! | |
| | | \brief | |
| | | Ensure that the column of \a item is visible within the multi-colum | |
| | | n | |
| | | listbox. | |
| | | | |
| | | \note | |
| | | This doesn't necessarily make \a item visible. | |
| | | | |
| | | \param item | |
| | | Pointer to the ListboxItem whose column is to be made visible in th | |
| | | e | |
| | | multi-column listbox. | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | */ | |
| | | void ensureItemColumnIsVisible(const ListboxItem* item); | |
| | | | |
| | | /*! | |
| | | \brief | |
| | | Ensure that the row with index \a row_idx is visible within the | |
| | | multi-column listbox. | |
| | | | |
| | | \param row_id | |
| | | row_idx is the zero-based index of the row to be made visible. | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | */ | |
| | | void ensureRowIsVisible(uint row_idx); | |
| | | | |
| | | /*! | |
| | | \brief | |
| | | Ensure that the column with ID \a column_idx is visible within the | |
| | | multi-column listbox. | |
| | | | |
| | | \param column_idx | |
| | | column_idx is the zero-based index of the column to be made visible | |
| | | . | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | */ | |
| | | void ensureColumnIsVisible(uint column_idx); | |
| | | | |
| | | /*! | |
| | | \brief | |
| | | Instruct column auto-sizing (autoSizeColumnHeader()) to also use th | |
| | | e | |
| | | list header segment size. | |
| | | | |
| | | \param include_header | |
| | | Whether method autoSizeColumnHeader() also should use the size of t | |
| | | he | |
| | | column header segment. | |
| | | | |
| | | \return | |
| | | Nothing. | |
| | | */ | |
| | | void setAutoSizeColumnUsesHeader(bool include_header); | |
| | | | |
| /*******************************************************************
****** | | /*******************************************************************
****** | |
| Construction and Destruction | | Construction and Destruction | |
| ********************************************************************
*****/ | | ********************************************************************
*****/ | |
| /*! | | /*! | |
| \brief | | \brief | |
| Constructor for the Multi-column list base class | | Constructor for the Multi-column list base class | |
| */ | | */ | |
| MultiColumnList(const String& type, const String& name); | | MultiColumnList(const String& type, const String& name); | |
| | | | |
| /*! | | /*! | |
| | | | |
| skipping to change at line 1536 | | skipping to change at line 1652 | |
| bool d_useNominatedRow; //!< true if we use a nomina
ted row to select. | | bool d_useNominatedRow; //!< true if we use a nomina
ted row to select. | |
| bool d_useNominatedCol; //!< true if we use a nomina
ted col to select. | | bool d_useNominatedCol; //!< true if we use a nomina
ted col to select. | |
| ListboxItem* d_lastSelected; //!< holds pointer to the last selec
ted item (used in range selections) | | ListboxItem* d_lastSelected; //!< holds pointer to the last selec
ted item (used in range selections) | |
| | | | |
| uint d_columnCount; //!< keeps track of the number of colum
ns. | | uint d_columnCount; //!< keeps track of the number of colum
ns. | |
| | | | |
| // storage of items in the list box. | | // storage of items in the list box. | |
| typedef std::vector<ListRow> ListItemGrid; | | typedef std::vector<ListRow> ListItemGrid; | |
| ListItemGrid d_grid; //!< Holds the list box data
. | | ListItemGrid d_grid; //!< Holds the list box data
. | |
| | | | |
|
| | | //! whether header size will be considered when auto-sizing columns. | |
| | | bool d_autoSizeColumnUsesHeader; | |
| | | | |
| friend class MultiColumnListWindowRenderer; | | friend class MultiColumnListWindowRenderer; | |
| | | | |
| private: | | private: | |
| /*******************************************************************
****** | | /*******************************************************************
****** | |
| Static Properties for this class | | Static Properties for this class | |
| ********************************************************************
*****/ | | ********************************************************************
*****/ | |
| static MultiColumnListProperties::ColumnsMovable
d_columnsMovableProperty; | | static MultiColumnListProperties::ColumnsMovable
d_columnsMovableProperty; | |
| static MultiColumnListProperties::ColumnsSizable
d_columnsSizableProperty; | | static MultiColumnListProperties::ColumnsSizable
d_columnsSizableProperty; | |
| static MultiColumnListProperties::ForceHorzScrollbar
d_forceHorzScrollProperty; | | static MultiColumnListProperties::ForceHorzScrollbar
d_forceHorzScrollProperty; | |
| static MultiColumnListProperties::ForceVertScrollbar
d_forceVertScrollProperty; | | static MultiColumnListProperties::ForceVertScrollbar
d_forceVertScrollProperty; | |
| static MultiColumnListProperties::NominatedSelectionColumnID d_no
minatedSelectColProperty; | | static MultiColumnListProperties::NominatedSelectionColumnID d_no
minatedSelectColProperty; | |
| static MultiColumnListProperties::NominatedSelectionRow
d_nominatedSelectRowProperty; | | static MultiColumnListProperties::NominatedSelectionRow
d_nominatedSelectRowProperty; | |
| static MultiColumnListProperties::SelectionMode
d_selectModeProperty; | | static MultiColumnListProperties::SelectionMode
d_selectModeProperty; | |
| static MultiColumnListProperties::SortColumnID
d_sortColumnIDProperty; | | static MultiColumnListProperties::SortColumnID
d_sortColumnIDProperty; | |
| static MultiColumnListProperties::SortDirection
d_sortDirectionProperty; | | static MultiColumnListProperties::SortDirection
d_sortDirectionProperty; | |
| static MultiColumnListProperties::SortSettingEnabled
d_sortSettingProperty; | | static MultiColumnListProperties::SortSettingEnabled
d_sortSettingProperty; | |
| static MultiColumnListProperties::ColumnHeader
d_columnHeaderProperty; | | static MultiColumnListProperties::ColumnHeader
d_columnHeaderProperty; | |
| static MultiColumnListProperties::RowCount
d_rowCountProperty; | | static MultiColumnListProperties::RowCount
d_rowCountProperty; | |
|
| | | static MultiColumnListProperties::AutoSizeColumnUsesHeader d_autoS
izeColumnUsesHeaderProperty; | |
| | | | |
| /*******************************************************************
****** | | /*******************************************************************
****** | |
| Private methods | | Private methods | |
| ********************************************************************
*****/ | | ********************************************************************
*****/ | |
| void addMultiColumnListProperties(void); | | void addMultiColumnListProperties(void); | |
| }; | | }; | |
| | | | |
| } // End of CEGUI namespace section | | } // End of CEGUI namespace section | |
| | | | |
| #if defined(_MSC_VER) | | #if defined(_MSC_VER) | |
| | | | |
End of changes. 4 change blocks. |
| 0 lines changed or deleted | | 129 lines changed or added | |
|
| CEGUIMultiColumnListProperties.h | | CEGUIMultiColumnListProperties.h | |
| | | | |
| skipping to change at line 349 | | skipping to change at line 349 | |
| RowCount() : Property( | | RowCount() : Property( | |
| "RowCount", | | "RowCount", | |
| "Property to access the number of rows in the list (read onl
y)", | | "Property to access the number of rows in the list (read onl
y)", | |
| "", false) | | "", false) | |
| {} | | {} | |
| | | | |
| String get(const PropertyReceiver* receiver) const; | | String get(const PropertyReceiver* receiver) const; | |
| void set(PropertyReceiver* receiver, const String& value); | | void set(PropertyReceiver* receiver, const String& value); | |
| }; | | }; | |
| | | | |
|
| | | /*! | |
| | | \brief | |
| | | Property to access whether the multi-column list will consider the widt | |
| | | h of | |
| | | the column header segment when auto-sizing a column. | |
| | | | |
| | | \par Usage: | |
| | | - Name: AutoSizeColumnUsesHeader | |
| | | - Format: "[text]" | |
| | | | |
| | | \par Where [Text] is: | |
| | | - "True" to indicate that when auto-sizing a column, the size of th | |
| | | e | |
| | | header should also be used. | |
| | | - "False" to indicate that the column width will only be auto-sized | |
| | | using the column contents. | |
| | | */ | |
| | | class AutoSizeColumnUsesHeader : public Property | |
| | | { | |
| | | public: | |
| | | AutoSizeColumnUsesHeader() : Property( | |
| | | "AutoSizeColumnUsesHeader", | |
| | | "Property to get/set the 'use header size' flag when auto-sizing a | |
| | | " | |
| | | "column. Value is either \"True\" or \"False\".", | |
| | | "False") | |
| | | {} | |
| | | | |
| | | String get(const PropertyReceiver* receiver) const; | |
| | | void set(PropertyReceiver* receiver, const String& value); | |
| | | }; | |
| | | | |
| } // End of MultiColumnListProperties namespace section | | } // End of MultiColumnListProperties namespace section | |
| | | | |
| } // End of CEGUI namespace section | | } // End of CEGUI namespace section | |
| | | | |
| #endif // end of guard _CEGUIMultiColumnListProperties_h_ | | #endif // end of guard _CEGUIMultiColumnListProperties_h_ | |
| | | | |
End of changes. 1 change blocks. |
| 0 lines changed or deleted | | 32 lines changed or added | |
|